A DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample. More...

Public Member Functions
virtual const class DynamicType *	get_type (void)=0
	This provides the type that defines the values within this sample.

virtual ReturnCode_t	get_descriptor (class MemberDescriptor *value, const MemberId id)=0
	This provides access to the descriptor for each value in this object, identified by the member ID. More...

virtual ReturnCode_t	set_descriptor (const MemberId id, const class MemberDescriptor *value)=0
	Set the descriptor of the member specified by 'id'.

virtual unsigned char	equals (const class DynamicData *other)=0
	Compare two DynamicData instances for equality. More...

virtual MemberId	get_member_id_by_name (const char *name)=0
	Access the 'id' of a member matching 'name'.

virtual MemberId	get_member_id_at_index (const unsigned int index)=0
	Access the 'id' of a member at the specified index.

virtual unsigned int	get_item_count ()=0
	Access the "item count" of the DDS_DynamicData. More...

virtual ReturnCode_t	get_name_by_id (const char **name_str, const MemberId id)=0
	Support for map instances. Access the key name by 'id' (index).

virtual ReturnCode_t	clear_all_values ()=0
	Clears all values from the instance. More...

virtual ReturnCode_t	clear_nonkey_values ()=0
	Clear all non-key values from the instance. More...

virtual ReturnCode_t	clear_value (const MemberId id)=0
	Clear the specified value from the instance. More...

virtual class DynamicData *	loan_value (const MemberId id)=0
	The "loan" operations loan to the application a DynamicData object representing a value within this sample. More...

virtual ReturnCode_t	return_loaned_value (const class DynamicData *value)=0
	Return a "loaned" data sample. More...

virtual class DynamicData *	clone ()=0
	Create and return a new data sample with the same contents as this one. More...

virtual ReturnCode_t	get_int32_value (int *value, const MemberId id)=0
	Access a 32bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_int32_value (const MemberId id, const int value)=0
	Set a 32bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_uint32_value (unsigned int *value, const MemberId id)=0
	Access an unsigned 32bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_uint32_value (const MemberId id, const unsigned int value)=0
	Set an unsigned 32bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_int16_value (short *value, const MemberId id)=0
	Access a 16bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_int16_value (const MemberId id, const short value)=0
	Set a 16bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_uint16_value (unsigned short *value, const MemberId id)=0
	Access an unsigned 16bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_uint16_value (const MemberId id, const unsigned short value)=0
	Set an unsigned 16bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_int64_value (int64_t *value, const MemberId id)=0
	Access a 64bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_int64_value (const MemberId id, const int64_t value)=0
	Set a 64bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_uint64_value (uint64_t *value, const MemberId id)=0
	Access an unsigned 64bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_uint64_value (const MemberId id, const uint64_t value)=0
	Set an unsigned 64bit integer value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_float32_value (float *value, const MemberId id)=0
	Access a float value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_float32_value (const MemberId id, const float value)=0
	Set a float value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_float64_value (double *value, const MemberId id)=0
	Access a double value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_float64_value (const MemberId id, const double value)=0
	Set a double value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_char8_value (char *value, const MemberId id)=0
	Access an 8bit character value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_char8_value (const MemberId id, const char value)=0
	Set an 8bit character value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_char32_value (cdx_char32_t *value, const MemberId id)=0
	Access a 32bit character value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_char32_value (const MemberId id, const cdx_char32_t value)=0
	Set a 32bit character value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_byte_value (unsigned char *value, const MemberId id)=0
	Access an 8bit value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_byte_value (const MemberId id, const unsigned char value)=0
	Set an 8bit value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_boolean_value (unsigned char *value, const MemberId id)=0
	Access a boolean value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_boolean_value (const MemberId id, const unsigned char value)=0
	Set a boolean value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_string_value (char **value, const MemberId id)=0
	Access a string value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_string_value (const MemberId id, const char *value)=0
	Set a string value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_wstring_value (cdx_char32_t **value, const MemberId id)=0
	Access a wstring value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_wstring_value (const MemberId id, const cdx_char32_t *value)=0
	Set a wstring value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_complex_value (class DynamicData **value, const MemberId id)=0
	Access a complex value, identified by 'id', in the sample. More...

virtual ReturnCode_t	set_complex_value (const MemberId id, class DynamicData *value)=0
	Set a complex value, identified by 'id', in the sample. More...

virtual ReturnCode_t	get_int32_values (Int32Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_int32_values (const MemberId id, const Int32Seq *value)=0

virtual ReturnCode_t	get_uint32_values (UInt32Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_uint32_values (const MemberId id, const UInt32Seq *value)=0

virtual ReturnCode_t	get_int16_values (Int16Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_int16_values (const MemberId id, const Int16Seq *value)=0

virtual ReturnCode_t	get_uint16_values (UInt16Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_uint16_values (const MemberId id, const UInt16Seq *value)=0

virtual ReturnCode_t	get_int64_values (Int64Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_int64_values (const MemberId id, const Int64Seq *value)=0

virtual ReturnCode_t	get_uint64_values (UInt64Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_uint64_values (const MemberId id, const UInt64Seq *value)=0

virtual ReturnCode_t	get_float32_values (Float32Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_float32_values (const MemberId id, const Float32Seq *value)=0

virtual ReturnCode_t	get_float64_values (Float64Seq *value, const MemberId id)=0

virtual ReturnCode_t	set_float64_values (const MemberId id, const Float64Seq *value)=0

virtual ReturnCode_t	get_char8_values (CharSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_char8_values (const MemberId id, const CharSeq *value)=0

virtual ReturnCode_t	get_char32_values (WcharSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_char32_values (const MemberId id, const WcharSeq *value)=0

virtual ReturnCode_t	get_byte_values (ByteSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_byte_values (const MemberId id, const ByteSeq *value)=0

virtual ReturnCode_t	get_boolean_values (BooleanSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_boolean_values (const MemberId id, const BooleanSeq *value)=0

virtual ReturnCode_t	get_string_values (StringSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_string_values (const MemberId id, const StringSeq *value)=0

virtual ReturnCode_t	get_wstring_values (WstringSeq *value, const MemberId id)=0

virtual ReturnCode_t	set_wstring_values (const MemberId id, const WstringSeq *value)=0

Protected Member Functions
	DynamicData ()

Detailed Description

A DynamicData object represents an individual data sample. It provides reflective getters and setters for the members of that sample.

Many of the properties and operations on DynamicData refer to values within the sample, which are identified by name, member ID, or index.

What constitutes a value within a sample, and which means of accessing it are valid, depends on the type of the sample.

If this instance is of an aggregated type, values correspond to the type’s members and can be accessed by name, member ID, or index.
If this instance is of a sequence or string type, values correspond to the elements of the collection. These elements must be accessed by index; the mapping from index to member ID is unspecified.
If this object is of a map type, values correspond to the values of the map. Map keys are implicitly converted to strings and can thus be used to look up map values by name. Map values can also be accessed by index, although the order is unspecified.
If the object is of an array type, values correspond to the elements of the array. These elements must be accessed by index; the mapping from index to member ID is unspecified. If the array is multi-dimensional, elements are accessed as if they were “flattened” into a single-dimensional array in the order specified by the IDL specification.
If the object is of a bit set type, values correspond to the flags within the bit set and are all of Boolean type. Named flags can be accessed using that name; any bit within the bound of the bit set may be accessed by its index. The mappings from name and index to member ID are unspecified.
If the object is of an enumeration or primitive type, it has no contained values. However, the value of the sample itself may be indicated by "name" using a nil or empty string, by "ID" by passing MEMBER_ID_INVALID, or by "index" by passing index 0.

Note that indices used here are always relative to other values in a particular DynamicData object. Even though member definitions within aggregate types have a well-defined order, the same is not true within data samples or across data samples.

Specifically, the index at which a member of an aggregated type appears in a particular data sample may not match that in which it appears in the corresponding type and may not match the index at which it appears in a different data sample.

There are several reasons for these inconsistencies:

The producer of the sample may be using a slightly different variant of the type than the consumer, which may add to, or omit elements from, the set of members known to the consumer.
An optional member may have no value; in such a case, it will be omitted, thereby decreasing the index of every subsequent member.
A non-optional member may likewise be omitted (which semantically is equivalent to it taking its default value). An implementation may discretionarily omit such members (e.g., to save space).
Preserving member order is not necessary or even desirable (e.g., for performance reasons) for certain data representations.
See also
DynamicType

DynamicDataFactory

Constructor & Destructor Documentation

DDS::DynamicData::DynamicData ( )

protected

Constructor, Copy Constructor, Destructor, Assignment operator

Member Function Documentation

virtual ReturnCode_t DDS::DynamicData::clear_all_values ( )

pure virtual

Clears all values from the instance.

The meaning of "clearing" a member depends on the type of data represented by this sample:

If this sample is of an aggregated type, and the indicated member is optional, remove it. If the indicated member is not optional, set it to its default value.
If this sample is of a variable-length collection type, remove the indicated element, shifting any subsequent elements to the next-lowest index.
If the sample is of an array type, set the indicated element to its default value.
If the sample is of a bit set type, clear the indicated bit.
If the sample is of an enumerated type, set it to the first value of the enumerated type.
If the sample is of a primitive type, set it to its default value.
The clear_all_members takes the above action for each value in turn.
The clear_nonkey_value operation has exactly the same effect as clear_all_values with one exception: the values of key fields of aggregated types retain their values.

virtual ReturnCode_t DDS::DynamicData::clear_nonkey_values ( )

pure virtual

Clear all non-key values from the instance.

See also: DynamicData::clear_all_values

virtual ReturnCode_t DDS::DynamicData::clear_value ( const MemberId id )

pure virtual

Clear the specified value from the instance.

See also: DynamicData::clear_all_values

virtual class DynamicData* DDS::DynamicData::clone ( )

pure virtual

Create and return a new data sample with the same contents as this one.

A comparison of this object and the clone using equals immediately following this call will return true.

virtual unsigned char DDS::DynamicData::equals ( const class DynamicData * other )

pure virtual

Compare two DynamicData instances for equality.

Two data samples are considered to be equal if and only if all of the following conditions hold:

Their respective type definitions are equal.
All contained values are equal and occur in the same order.

If the samples’ type is an aggregated type, the previous rule is amended as follows:

Members shall be compared without regard to their order.
One of the samples may omit a non-optional member that is present in the other if that member takes its default value in the latter sample.

virtual ReturnCode_t DDS::DynamicData::get_boolean_value	(	unsigned char *	value,
		const MemberId	id
	)

pure virtual

Access a boolean value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_boolean_values	(	BooleanSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_byte_value	(	unsigned char *	value,
		const MemberId	id
	)

pure virtual

Access an 8bit value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_byte_values	(	ByteSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_char32_value	(	cdx_char32_t *	value,
		const MemberId	id
	)

pure virtual

Access a 32bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_char32_values	(	WcharSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_char8_value	(	char *	value,
		const MemberId	id
	)

pure virtual

Access an 8bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_char8_values	(	CharSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_complex_value	(	class DynamicData **	value,
		const MemberId	id
	)

pure virtual

Access a complex value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_descriptor	(	class MemberDescriptor *	value,
		const MemberId	id
	)

pure virtual

This provides access to the descriptor for each value in this object, identified by the member ID.

See the description of DynamicData values.

virtual ReturnCode_t DDS::DynamicData::get_float32_value	(	float *	value,
		const MemberId	id
	)

pure virtual

Access a float value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_float32_values	(	Float32Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_float64_value	(	double *	value,
		const MemberId	id
	)

pure virtual

Access a double value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_float64_values	(	Float64Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_int16_value	(	short *	value,
		const MemberId	id
	)

pure virtual

Access a 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_int16_values	(	Int16Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_int32_value	(	int *	value,
		const MemberId	id
	)

pure virtual

Access a 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_int32_values	(	Int32Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_int64_value	(	int64_t *	value,
		const MemberId	id
	)

pure virtual

Access a 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_int64_values	(	Int64Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual unsigned int DDS::DynamicData::get_item_count ( )

pure virtual

Access the "item count" of the DDS_DynamicData.

The "item count" of the data depends on the type of the object.

If the object is of a collection type, return the number of elements currently in the collection.
In the case of an array type, this value will always be equal to the product of the bounds of all array dimensions.
If the object is of a bit set type, return the number of named flags that are currently set in the bit set.
If the object is of a structure or annotation type, return the number of members in the object. This value may be different than the number of members in the corresponding DDS_DynamicType; for example, some optional members may be omitted.
If the object is of a union type, return the number of members in the object. This value will always be two: the discriminator and the current member corresponding to it.
If the object is of a primitive or enumeration type, it is atomic, and the count is one.
If the object is of an alias type, return the value appropriate for the alias’s base type.

virtual ReturnCode_t DDS::DynamicData::get_string_value	(	char **	value,
		const MemberId	id
	)

pure virtual

Access a string value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_string_values	(	StringSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_uint16_value	(	unsigned short *	value,
		const MemberId	id
	)

pure virtual

Access an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_uint16_values	(	UInt16Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_uint32_value	(	unsigned int *	value,
		const MemberId	id
	)

pure virtual

Access an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_uint32_values	(	UInt32Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_uint64_value	(	uint64_t *	value,
		const MemberId	id
	)

pure virtual

Access an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_uint64_values	(	UInt64Seq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::get_wstring_value	(	cdx_char32_t **	value,
		const MemberId	id
	)

pure virtual

Access a wstring value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::get_wstring_values	(	WstringSeq *	value,
		const MemberId	id
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual class DynamicData* DDS::DynamicData::loan_value ( const MemberId id )

pure virtual

The "loan" operations loan to the application a DynamicData object representing a value within this sample.

This operation allows applications to visit values without allocating additional DynamicData objects or copying values. This loan shall be returned by the DDS_DynamicData_return_loaned_value operation.

A given DynamicData object may support only a single outstanding loan at a time. That is, after calling a "loan" operation, an application must subsequently call return_loaned_value before calling a loan operation again. If an application violates this constraint, the loan operation shall return a nil value.

A loan operation shall also return a nil value if the indicated value does not exist.

virtual ReturnCode_t DDS::DynamicData::return_loaned_value ( const class DynamicData * value )

pure virtual

Return a "loaned" data sample.

The DynamicData::return_loaned_value operation may return RETCODE_PRECONDITION_NOT_MET if the provided sample object does not represent an outstanding loan from the sample on which the operation is invoked.

virtual ReturnCode_t DDS::DynamicData::set_boolean_value	(	const MemberId	id,
		const unsigned char	value
	)

pure virtual

Set a boolean value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_boolean_values	(	const MemberId	id,
		const BooleanSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_byte_value	(	const MemberId	id,
		const unsigned char	value
	)

pure virtual

Set an 8bit value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_byte_values	(	const MemberId	id,
		const ByteSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_char32_value	(	const MemberId	id,
		const cdx_char32_t	value
	)

pure virtual

Set a 32bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_char32_values	(	const MemberId	id,
		const WcharSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_char8_value	(	const MemberId	id,
		const char	value
	)

pure virtual

Set an 8bit character value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_char8_values	(	const MemberId	id,
		const CharSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_complex_value	(	const MemberId	id,
		class DynamicData *	value
	)

pure virtual

Set a complex value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_float32_value	(	const MemberId	id,
		const float	value
	)

pure virtual

Set a float value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_float32_values	(	const MemberId	id,
		const Float32Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_float64_value	(	const MemberId	id,
		const double	value
	)

pure virtual

Set a double value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_float64_values	(	const MemberId	id,
		const Float64Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_int16_value	(	const MemberId	id,
		const short	value
	)

pure virtual

Set a 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_int16_values	(	const MemberId	id,
		const Int16Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_int32_value	(	const MemberId	id,
		const int	value
	)

pure virtual

Set a 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_int32_values	(	const MemberId	id,
		const Int32Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_int64_value	(	const MemberId	id,
		const int64_t	value
	)

pure virtual

Set a 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_int64_values	(	const MemberId	id,
		const Int64Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_string_value	(	const MemberId	id,
		const char *	value
	)

pure virtual

Set a string value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_string_values	(	const MemberId	id,
		const StringSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_uint16_value	(	const MemberId	id,
		const unsigned short	value
	)

pure virtual

Set an unsigned 16bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_uint16_values	(	const MemberId	id,
		const UInt16Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_uint32_value	(	const MemberId	id,
		const unsigned int	value
	)

pure virtual

Set an unsigned 32bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_uint32_values	(	const MemberId	id,
		const UInt32Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_uint64_value	(	const MemberId	id,
		const uint64_t	value
	)

pure virtual

Set an unsigned 64bit integer value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_uint64_values	(	const MemberId	id,
		const UInt64Seq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

virtual ReturnCode_t DDS::DynamicData::set_wstring_value	(	const MemberId	id,
		const cdx_char32_t *	value
	)

pure virtual

Set a wstring value, identified by 'id', in the sample.

If 'id' is MEMBER_ID_INVALID, then it attempts to treat 'dd' as the requested type. Otherwise, it looks in 'dd' for a value that matches that 'id'. As described above, 'id' has different meanings based on the type of 'dd'.

Return values

RETCODE_BAD_PARAMETER in the case of an invalid parameter or non-existent 'id'.

virtual ReturnCode_t DDS::DynamicData::set_wstring_values	(	const MemberId	id,
		const WstringSeq *	value
	)

pure virtual

Not Yet Supported:: This operation is not yet implemented.

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation