DynamicTypeMember Class Reference

A DynamicTypeMember represents a "member" of a type. A "member" in this sense may be a member of an aggregated type, a constant within an enumeration, or some other type substructure. More...

Inherits DynamicTypeMember.

Public Member Functions
ReturnCode_t	get_descriptor (ref DDS_MemberDescriptor descriptor)
	This operation accesses the current state of this type. More...
uint	get_annotation_count ()
	Return the number of annotations applied to this type. More...
ReturnCode_t	get_annotation (ref DDS_AnnotationDescriptor descriptor, uint idx)
	Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
bool	equals (DDS_DynamicTypeMember other)
	Compare two DynamicTypeMember's. More...
uint	get_id ()
	This convenience operation provides the member ID of this member. More...
String	get_name ()
	This convenience operation provides the name of this member. More...

Detailed Description

A DynamicTypeMember represents a "member" of a type. A "member" in this sense may be a member of an aggregated type, a constant within an enumeration, or some other type substructure.

See also

DynamicType

DynamicTypeBuilderFactory

DynamicTypeBuilder

Member Function Documentation

equals()

bool equals ( DDS_DynamicTypeMember  other )

inline

Compare two DynamicTypeMember's.

Two type descriptors are considered equal if and only if if they belong to the same type and the values of all of the properties are equal in each of them.

get_annotation()

ReturnCode_t get_annotation ( ref DDS_AnnotationDescriptor  descriptor, uint  idx  )

inline

Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation.

Not Yet Supported:

This operation is not yet implemented.

get_annotation_count()

uint get_annotation_count ( )

inline

Return the number of annotations applied to this type.

Return values

uint	the number of annotations

Not Yet Supported:

This operation is not yet implemented.

get_descriptor()

ReturnCode_t get_descriptor ( ref DDS_MemberDescriptor  descriptor )

inline

This operation accesses the current state of this type.

It overwrites the application-provided 'descriptor' parameter.

Return values

RETCODE_BAD_PARAMETER

in the case of an invalid parameter

get_id()

uint get_id ( )

inline

This convenience operation provides the member ID of this member.

Its result shall be identical to the ID value that is a member of the descriptor property.

get_name()

String get_name ( )

inline

This convenience operation provides the name of this member.

Its result shall be identical to the name string that is a member of the descriptor property.