
APIS - AcQ Platform Interface Software
Programmer’s Manual Version: 2.1
AcQuisition Technology bv
P.O. Box 627, 5340 AP
Oss, The Netherlands
Page 10 of 77
3.3. APIS APPLICATION PROGRAMMING INTERFACE
In this section the application programming interface (API) for APIS is described.
The Application Programming Interface for APIS is implemented in two ANSI-C coded definition files:
apis.h which contains general definitions and platform_apis.h which contains platform specific
definitions and references to the APIS function calls.
The application source file must include the APIS header file apis.h. Porting of the application to a
platform, consists of re-compiling the source code with a defined pre-processor macro for selection of
the used platform. The APIS header file contains generic APIS definitions and includes a platform
specific header file according to the platform selection macro.
API calls are translated to the platform specific calls in the APIS header file and the platform specific
definition file platform_apis.h (platform is a name that identifies a hardware and operating system
combination, e.g. i4000os9).
Although apis.h contains general APIS definitions, it can contain specific definitions that are somehow
related between a range of platforms, e.g. M-module carrier boards.
The macro PLATFORM must be defined, either via a pre-processor definition provided at compile
time or via a macro-definition in the application source. A valid platform name must be assigned to
the macro PLATFORM, the platform name must be defined as a unique decimal number in the file
apis.h. The macro PLATFORM ensures that the correct platform dependent definition file is included.
3.3.1. PLATFORM IDENTIFIER
The platform identifier is a name that is used to refer to a platform, defined as the combination of a
hardware product and the operating system environment in which it is used. The platform identifier is
used in file names and directories as well as in function names. The platform name used in a function
name starts with an underscore ( _platform_function()).
The platform name must be a unique string of maximal 10 characters, for instance i4000os9 for the
platform consisting of the i4000 M-module carrier board and the operating system OS-9.
Comentarios a estos manuales