Initialization API

The initializations APIs consist of the functions or classes that are used to create a data connection.

These connections are required before data can move between an AE and the database. Except for the Language Development Kit (LDK), which is a C-language API, each language supports initialization high-level functionality to create a data connection. They are:
  • C++: class NzaeApiGenerator
  • Java: class NzaeApiGenerator
  • Fortran: subroutine nzaeRun()
  • Python: derive from class nzae.Ae
  • Perl: derive from class nzae.Ae
  • R: function determineAEMode()

The C API contains initialization functions that operate on a lower level. Some languages, such as C++ and Java, also support these lower-level API features. When starting out with AEs (other than with the LDK), use the high-level process to create a connection. The lower-level API is most useful for remote AE processes not launched by NPS.

Each of the language reference guides includes a section or page describing initialization. When using the higher-level initialization, most of this documentation is not needed.

The Table function (simulated row function) examples and in Simple remote mode examples, Scalar Function (Remote Mode) examples for the various supported languages show initialization in full, typically supporting both local and remote AE. In these examples, for the LDK (C API), low-level initialization is shown. For the other languages, high-level initialization is shown.