RTI Connext Traditional C++ API
Version 6.0.0
|
Defines generic classes and macros to support user data types. More...
Classes | |
struct | DDS_TypeAllocationParams_t |
Configures whether or not to allocate pointer and optional members. More... | |
struct | DDS_TypeDeallocationParams_t |
Configures whether to release or not pointer and optional members. More... | |
struct | Foo |
A representative user-defined data type. More... | |
struct | DDS_InstanceHandleSeq |
Instantiates FooSeq < DDS_InstanceHandle_t > . More... | |
class | FooTypeSupport |
<<interface>> <<generic>> User data type specific interface. More... | |
class | DDSTypeSupport |
<<interface>> An abstract marker interface that has to be specialized for each concrete user data type that will be used by the application. More... | |
Macros | |
#define | DDS_TYPESUPPORT_CPP(TTypeSupport, TData) |
Declares the interface required to support a user data type. | |
#define | DDS_DATAWRITER_CPP(TDataWriter, TData) |
Declares the interface required to support a user data type specific data writer. | |
#define | DDS_DATAREADER_W_DATA_CONSISTENCY_CHECK(TDataReader, TDataSeq, TData) |
Declares the interface required to support a user data type-specific data reader. | |
Typedefs | |
typedef DDS_HANDLE_TYPE_NATIVE | DDS_InstanceHandle_t |
Type definition for an instance handle. | |
Functions | |
DDS_Boolean | DDS_InstanceHandle_equals (const DDS_InstanceHandle_t *self, const DDS_InstanceHandle_t *other) |
Compares this instance handle with another handle for equality. | |
int | DDS_InstanceHandle_compare (const DDS_InstanceHandle_t *self, const DDS_InstanceHandle_t *other) |
Compares this instance handle with another handle. | |
DDS_Boolean | DDS_InstanceHandle_is_nil (const DDS_InstanceHandle_t *self) |
Compare this handle to DDS_HANDLE_NIL. | |
Variables | |
const DDS_InstanceHandle_t | DDS_HANDLE_NIL |
The NIL instance handle. | |
Defines generic classes and macros to support user data types.
DDS specifies strongly typed interfaces to read and write user data. For each data class defined by the application, there is a number of specialised classes that are required to facilitate the type-safe interaction of the application with RTI Connext.
RTI Connext provides an automatic means to generate all these type-specific classes with the rtiddsgen utility. The complete set of automatic classes created for a hypothetical user data type named Foo
are shown below.
Foo
The macros defined here declare the strongly typed APIs needed to support an arbitrary user defined data of type Foo
.
#define DDS_TYPESUPPORT_CPP | ( | TTypeSupport, | |
TData | |||
) |
Declares the interface required to support a user data type.
Foo
, i.e. FooTypeSupport
#define DDS_DATAWRITER_CPP | ( | TDataWriter, | |
TData | |||
) |
Declares the interface required to support a user data type specific data writer.
Foo
Foo
, i.e. FooDataWriter
#define DDS_DATAREADER_W_DATA_CONSISTENCY_CHECK | ( | TDataReader, | |
TDataSeq, | |||
TData | |||
) |
Declares the interface required to support a user data type-specific data reader.
Foo
FooSeq sequence of user data type, sequence<::Foo>
Foo
, i.e. FooDataReader
typedef DDS_HANDLE_TYPE_NATIVE DDS_InstanceHandle_t |
Type definition for an instance handle.
Handle to identiy different instances of the same DDSTopic of a certain type.
DDS_Boolean DDS_InstanceHandle_equals | ( | const DDS_InstanceHandle_t * | self, |
const DDS_InstanceHandle_t * | other | ||
) |
Compares this instance handle with another handle for equality.
self | <<in>> This handle. Cannot be NULL. |
other | <<in>> The other handle to be compared with this handle. Cannot be NULL. |
int DDS_InstanceHandle_compare | ( | const DDS_InstanceHandle_t * | self, |
const DDS_InstanceHandle_t * | other | ||
) |
Compares this instance handle with another handle.
self | <<in>> This handle. Cannot be NULL. |
other | <<in>> The other handle to be compared with this handle. Cannot be NULL. |
DDS_Boolean DDS_InstanceHandle_is_nil | ( | const DDS_InstanceHandle_t * | self | ) |
Compare this handle to DDS_HANDLE_NIL.
const DDS_InstanceHandle_t DDS_HANDLE_NIL |
The NIL instance handle.
Special DDS_InstanceHandle_t value