DDSTopic entity and associated elements More...

Classes
struct	DDS_PrintFormatProperty
	A collection of attributes used to configure how data samples will be formatted when converted to a string. More...

struct	DDS_InconsistentTopicStatus
	DDS_INCONSISTENT_TOPIC_STATUS More...

struct	DDS_TopicQos
	QoS policies supported by a DDSTopic entity. More...

struct	DDS_ExpressionProperty
	Provides additional information about the filter expression passed to DDSWriterContentFilter::writer_compile. More...

struct	DDS_FilterSampleInfo
	Provides meta information associated with the sample. More...

class	DDSTopicDescription
	<<interface>> Base class for DDSTopic, DDSContentFilteredTopic, and DDSMultiTopic. More...

class	DDSContentFilteredTopic
	<<interface>> Specialization of DDSTopicDescription that allows for content-based subscriptions. More...

class	DDSMultiTopic
	[Not supported (optional)] <<interface>> A specialization of DDSTopicDescription that allows subscriptions that combine/filter/rearrange data coming from several topics. More...

class	DDSTopic
	<<interface>> The most basic description of the data to be published and subscribed. More...

class	DDSTopicListener
	<<interface>> DDSListener for DDSTopic entities. More...

class	DDSContentFilter
	<<interface>> Interface to be used by a custom filter of a DDSContentFilteredTopic More...

class	DDSWriterContentFilter
	<<interface>> Interface to be used by a custom filter of a DDSContentFilteredTopic. More...

Typedefs
typedef struct DDS_PrintFormatProperty	DDS_PrintFormatProperty
	A collection of attributes used to configure how data samples will be formatted when converted to a string. More...

Enumerations
enum	DDS_PrintFormatKind { DDS_DEFAULT_PRINT_FORMAT, DDS_XML_PRINT_FORMAT, DDS_JSON_PRINT_FORMAT }
	Format kinds available when converting data samples to string representations. More...

Functions
DDS_Boolean	DDS_TopicQos_equals (const struct DDS_TopicQos self, const struct DDS_TopicQos other)
	Compares two DDS_TopicQos for equality. More...

DDS_ReturnCode_t	DDS_TopicQos::print () const
	Prints this DDS_TopicQos to stdout. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size) const
	Obtains a string representation of this DDS_TopicQos. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_TopicQos &base) const
	Obtains a string representation of this DDS_TopicQos. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_TopicQos. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_TopicQos &base, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_TopicQos. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
	Obtains a string representation of this DDS_TopicQos. More...

DDS_ReturnCode_t	DDS_TopicQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_TopicQos. More...

Variables
const struct DDS_PrintFormatProperty	DDS_PRINT_FORMAT_PROPERTY_DEFAULT
	Sentinel constant indicating default values for DDS_PrintFormatProperty. More...

Detailed Description

DDSTopic entity and associated elements

Typedef Documentation

◆ DDS_PrintFormatProperty

typedef struct DDS_PrintFormatProperty DDS_PrintFormatProperty

A collection of attributes used to configure how data samples will be formatted when converted to a string.

Enumeration Type Documentation

◆ DDS_PrintFormatKind

enum DDS_PrintFormatKind

Format kinds available when converting data samples to string representations.

Enumerator
DDS_DEFAULT_PRINT_FORMAT	Use a default format specific to RTI Connext to represent the data when converting to a string.
DDS_XML_PRINT_FORMAT	Use an XML format to represent the data when converting to a string.
DDS_JSON_PRINT_FORMAT	Use a JSON format to represent the data when converting to a string.

Function Documentation

◆ DDS_TopicQos_equals()

DDS_Boolean DDS_TopicQos_equals	(	const struct DDS_TopicQos *	self,
		const struct DDS_TopicQos *	other
	)

Compares two DDS_TopicQos for equality.

Parameters

self	<<in>> This TopicQos.
other	<<in>> The other TopicQos to be compared with this TopicQos

Returns: DDS_BOOLEAN_TRUE if the two Qos objects are equal or DDS_BOOLEAN_FALSE otherwise.

Referenced by DDS_TopicQos::operator!=(), and DDS_TopicQos::operator==().

◆ print()

DDS_ReturnCode_t DDS_TopicQos::print ( ) const

inline

Prints this DDS_TopicQos to stdout.

Only the differences between this DDS_TopicQos and the documented default are printed. If you wish to print everything regardless, see DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

Returns: DDS_RETCODE_OK if no error was encountered.

◆ to_string() [1/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

Only the differences between this DDS_TopicQos and the documented default are printed to the string. If you wish to print everything regardless, see DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_TopicQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns: DDS_RETCODE_OK if no error was encountered.

See also: DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const

◆ to_string() [2/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_TopicQos &	base
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

This overload behaves the same as DDS_TopicQos::to_string but allows the caller to specify the DDS_TopicQos, which is used as the base profile. Only the differences between the QoS and the base profile are included in the output string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_TopicQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.

Returns: DDS_RETCODE_OK if no error was encountered.

See also: DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

◆ to_string() [3/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_QosPrintFormat &	format
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

This overload behaves the same as DDS_TopicQos::to_string but allows the caller to specify the DDS_QosPrintFormat which is used to format the output.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns: DDS_RETCODE_OK if no error was encountered.

See also: DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const

References DDS_RETCODE_ERROR, and DDS_RETCODE_OK.

◆ to_string() [4/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_TopicQos &	base,
		const DDS_QosPrintFormat &	format
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

Only the differences between this DDS_TopicQos and the DDS_TopicQos supplied as the base are printed to the string.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_TopicQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_TopicQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns: DDS_RETCODE_OK if no error was encountered.

◆ to_string() [5/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_QosPrintAll_t &
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

This overload behaves the same as DDS_TopicQos::to_string but prints the entire DDS_TopicQos object. The only valid value for the argument of type DDS_QosPrintAll_t is DDS_QOS_PRINT_ALL.

For example

TopicQos qos;
char *str = NULL;
DDS_UnsignedLong str_size = 0;
qos.to_string(str, str_size, QOS_PRINT_ALL);

The resultant string is formatted according to the default value for DDS_QosPrintFormat.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns: DDS_RETCODE_OK if no error was encountered.

See also: DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

◆ to_string() [6/6]

DDS_ReturnCode_t DDS_TopicQos::to_string	(	char *	string,
		DDS_UnsignedLong &	string_size,
		const DDS_QosPrintAll_t &	,
		const DDS_QosPrintFormat &	format
	)		const

inline

Obtains a string representation of this DDS_TopicQos.

This overload behaves the same as the DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_QosPrintAll_t&) const overload. The only difference is that it allows the caller to specify the DDS_QosPrintFormat which is used to format the resultant string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_TopicQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns: DDS_RETCODE_OK if no error was encountered.

See also: DDS_TopicQos::to_string(char*, DDS_UnsignedLong&, const DDS_TopicQos&, const DDS_QosPrintFormat&) const

Variable Documentation

◆ DDS_PRINT_FORMAT_PROPERTY_DEFAULT

const struct DDS_PrintFormatProperty DDS_PRINT_FORMAT_PROPERTY_DEFAULT

Sentinel constant indicating default values for DDS_PrintFormatProperty.

Pass this object instead of your own DDS_PrintFormatProperty object to use the default property values:

retCode = FooTypeSupport::data_to_string( 
     sample, 
     DDS_PRINT_FORMAT_PROPERTY_DEFAULT); 

See also: DDS_PrintFormatProperty

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ DDS_PrintFormatProperty

Enumeration Type Documentation

◆ DDS_PrintFormatKind

Function Documentation

◆ DDS_TopicQos_equals()

◆ print()

◆ to_string() [1/6]

◆ to_string() [2/6]

◆ to_string() [3/6]

◆ to_string() [4/6]

◆ to_string() [5/6]

◆ to_string() [6/6]

Variable Documentation

◆ DDS_PRINT_FORMAT_PROPERTY_DEFAULT