This page describes an older version of the product. The latest stable version is 16.2.1.

API Code Generator

The *gs.xml file and the gsxml2cpp utility allow you to use your C++ classes in the space without a need for mapping or special knowledge regarding other APIs. This file is in charge of generating the C++ class serialization code, allowing you to use your C++ classes in the space. It can also be used to generate the C++ class header file and POJO Java file.

Here is the general flow:

  • To define your classes in the space using the *.gs.xml file, perform the following steps:
  1. Write a *gs.xml file, defining its XML elements as desired.
  2. Run the gsxml2cpp command – this command generates the serializer code, which includes the classes defined in your gs.xml file.
  3. Compile the serializer code – this is done using the gsxml2cpp command cpp output parameter. For an example of how to do this, refer to the C++ Hello World Example.
  4. Compiling the serializer code generates a DLL/OS file in the format of: serialize.dll or serialize.so. Copy the DLL/SO file to the <XAP Root>\lib\platform\native directory.

You can now use your C++ classes inside the space.

See also:

For an explanation of the different gs.xml elements, refer to the CPP API Mapping File section.

To find out about the supported C++ types, refer to the Supported Types section.

For an explanation of the gsxml2cpp command and how to use it, refer to the gsxml2cpp Utility section.