User Data Type Support
[Topic Module]

Defines generic classes and macros to support user data types. More...

Classes
struct	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...
struct	Foo
	A representative user-defined data type. More...
struct	DDS_InstanceHandleSeq
	Instantiates FooSeq < DDS_InstanceHandle_t > . More...
Defines
#define	DDS_TYPESUPPORT_CPP(TTypeSupport, TData)
	Declares the interface required to support a user data type.
#define	DDS_DATAWRITER_CPP_METP(TDataWriter, TData)
	Declares the interface required to support a user data type specific data writer.
#define	DDS_DATAREADER_CPP_METP(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.
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.

---

Detailed Description

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.

Classes auto-created for an application data type named Foo

The macros defined here declare the strongly typed APIs needed to support an arbitrary user defined data of type Foo.

See also:

rtiddsgen

---

Define Documentation

#define DDS_TYPESUPPORT_CPP	(	TTypeSupport,
		TData		)

Declares the interface required to support a user data type.

Defines:

FooTypeSupport TypeSupport of type Foo, i.e. FooTypeSupport

Examples:

HelloWorldSupport.cxx.

#define DDS_DATAWRITER_CPP_METP	(	TDataWriter,
		TData		)

Declares the interface required to support a user data type specific data writer.

Uses:

FooTypeSupport user data type, Foo

Defines:

FooDataWriter DDSDataWriter of type Foo, i.e. FooDataWriter

#define DDS_DATAREADER_CPP_METP	(	TDataReader,
		TDataSeq,
		TData		)

Declares the interface required to support a user data type-specific data reader.

Uses:

FooTypeSupport user data type, Foo FooSeq sequence of user data type, sequence<::Foo>

Defines:

FooDataReader DDSDataReader of type Foo, i.e. FooDataReader

See also:

FooSeq

---

Typedef Documentation

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.

See also:

FooDataWriter::register_instance

DDS_SampleInfo::instance_handle

Examples:

HelloWorld_publisher.cxx.

---

Function Documentation

DDS_Boolean DDS_InstanceHandle_equals	(	const DDS_InstanceHandle_t *	self,
		const DDS_InstanceHandle_t *	other
	)

Compares this instance handle with another handle for equality.

Parameters:

	self	<<in>> This handle. Cannot be NULL.
	other	<<in>> The other handle to be compared with this handle. Cannot be NULL.

Returns:

DDS_BOOLEAN_TRUE if the two handles have equal values, or DDS_BOOLEAN_FALSE otherwise.

See also:

DDS_InstanceHandle_is_nil

DDS_Boolean DDS_InstanceHandle_is_nil

(

const DDS_InstanceHandle_t *

self

)

Compare this handle to DDS_HANDLE_NIL.

Returns:

DDS_BOOLEAN_TRUE if the given instance handle is equal to DDS_HANDLE_NIL or DDS_BOOLEAN_FALSE otherwise.

See also:

DDS_InstanceHandle_equals

---

Variable Documentation

const DDS_InstanceHandle_t DDS_HANDLE_NIL

The NIL instance handle.

Special DDS_InstanceHandle_t value

See also:

DDS_InstanceHandle_is_nil

Examples:

HelloWorld_publisher.cxx.