Application Generation API

Functions
APPGENDllExport struct RT_ComponentFactoryI *	APPGEN_Factory_get_interface (void)
	Gets the singleton instance of the Application Generation factory.
APPGENDllExport RTI_BOOL	APPGEN_Factory_register (RT_Registry_T *registry, struct APPGEN_FactoryProperty *property)
	Registers the Micro Application Generation factory.
APPGENDllExport RTI_BOOL	APPGEN_Factory_unregister (RT_Registry_T *registry, struct APPGEN_FactoryProperty **property)
	Unregisters the Micro Application Generation factory.
APPGENDllExport const char *	APPGEN_Factory_get_version (void)
	Returns the version string for the Application Generation library.

---

Detailed Description

The AppGen plugin is an implementation of the RTI Connext DDS Micro DDS_AppGen plugin interface and implements the application generation supported by RTI Connext DDS Micro. RTI Connext DDS Micro requires that a DDS_AppGen plugin is registered with the name "_mag" in the DomainParticipantFactory before a participant can be created. Each call to DDS_DomainParticipantFactory_create_participant_from_config creates its own instance of the DDS_AppGen plugin. Please refer to User Manual for an example on how to register the application generation factory.

---

Function Documentation

APPGENDllExport struct RT_ComponentFactoryI* APPGEN_Factory_get_interface ( void  )

read

Gets the singleton instance of the Application Generation factory.

This function gets the singleton instance of the Application Generation plugin factory that is used by the middleware to create an AppGen plugin. The singleton instance of the factory must be registered with the name "_mag" in the DomainParticipantFactory.

Returns:

Pointer to Application Generation plugin factory

APPGENDllExport RTI_BOOL APPGEN_Factory_register	(	RT_Registry_T *	registry,
		struct APPGEN_FactoryProperty *	property
	)

Registers the Micro Application Generation factory.

Parameters:

registry	Registry with which to register the component factory. Cannot be NULL.
property	Pointer to factory properties

Returns:

BOOLEAN_TRUE if factory is successfully registered BOOLEAN_FALSE in case of error.

APPGENDllExport RTI_BOOL APPGEN_Factory_unregister	(	RT_Registry_T *	registry,
		struct APPGEN_FactoryProperty **	property
	)

Unregisters the Micro Application Generation factory.

Parameters:

registry	Registry with which to register the component factory. Cannot be NULL.
property	Pointer where to copy the pointer to the factory properties passed in call to function AppGenFactory_register().

Returns:

BOOLEAN_TRUE if factory is successfully unregistered. BOOLEAN_FALSE in case of error.

APPGENDllExport const char* APPGEN_Factory_get_version

(

void

)

Returns the version string for the Application Generation library.