DDS::AnnotationDescriptor Class Reference

A AnnotationDescriptor object comprises the state of an annotation as it is applied to some element. More...

Public Member Functions
	AnnotationDescriptor ()
ReturnCode_t	get_value (char **value, const char *key)
	This accesses an annotation property 'value' associated with the 'key' name. More...
ReturnCode_t	get_all_value (Parameters *value)
	Access the map of all key-value pairs. More...
ReturnCode_t	set_value (const char *key, const char *value)
ReturnCode_t	copy_from (const class AnnotationDescriptor *other)
unsigned char	equals (const class AnnotationDescriptor *other)
unsigned char	is_consistent ()

Public Attributes
class DynamicType *	type

Detailed Description

A AnnotationDescriptor object comprises the state of an annotation as it is applied to some element.

Constructor & Destructor Documentation

DDS::AnnotationDescriptor::AnnotationDescriptor

(

)

Constructor, Copy Constructor, Destructor, Assignment operator

Member Function Documentation

ReturnCode_t DDS::AnnotationDescriptor::copy_from

(

const class AnnotationDescriptor *

other

)

Not Yet Supported:

This operation is not yet implemented.

unsigned char DDS::AnnotationDescriptor::equals

(

const class AnnotationDescriptor *

other

)

Not Yet Supported:

This operation is not yet implemented.

ReturnCode_t DDS::AnnotationDescriptor::get_all_value

(

Parameters *

value

)

Access the map of all key-value pairs.

Return values

RETCODE_OK

on success, the 'value' parameters map is populated.

Not Yet Supported:

This operation is not yet implemented.

ReturnCode_t DDS::AnnotationDescriptor::get_value	(	char **	value,
		const char *	key
	)

This accesses an annotation property 'value' associated with the 'key' name.

Every attribute value is represented as a string although annotation type members can have other types as well. A string representation of a data value is considered well formed if it would be a valid IDL literal of the corresponding type with the following qualifications:

• String and character literals shall not be surrounded by quotation characters (‘"’ or ‘'’)
• All expressions shall be fully evaluated such that no operators or other non-literal characters occur in the value. For example, "5" is a well-formed string representation of the integer quantity five, but "2 + ENUM_VALUE_THREE" is not.

  Not Yet Supported:

  This operation is not yet implemented.

unsigned char DDS::AnnotationDescriptor::is_consistent

(

)

Not Yet Supported:

This operation is not yet implemented.

ReturnCode_t DDS::AnnotationDescriptor::set_value	(	const char *	key,
		const char *	value
	)

Not Yet Supported:

This operation is not yet implemented.

Member Data Documentation

class DynamicType* DDS::AnnotationDescriptor::type

the annotation type