DynamicDataMemberInfo Class Reference

A descriptor for a single member (i.e. field) of dynamically defined data type. More...

Inherits Struct.

Public Member Functions
	DynamicDataMemberInfo ()
	A descriptor for a single member (i.e. field) of dynamically defined data type. More...
	DynamicDataMemberInfo (int member_id, String member_name, boolean member_exists, TCKind member_kind, int representation_count, int element_count, TCKind element_kind)
	A descriptor for a single member (i.e. field) of dynamically defined data type. More...

Public Attributes
int	member_id
	An integer that uniquely identifies the data member within this com.rti.dds.dynamicdata.DynamicData sample's type. More...
String	member_name
	The string name of the data member. More...
boolean	member_exists
	Indicates whether the member exists in this sample. More...
TCKind	member_kind
	The kind of type of this data member (e.g., integer, structure, etc.). More...
int	element_count
	The number of elements within this data member. More...
TCKind	element_kind
	The kind of type of the elements within this data member. More...

Detailed Description

A descriptor for a single member (i.e. field) of dynamically defined data type.

See also

com.rti.dds.dynamicdata.DynamicData.get_member_info

Member Data Documentation

member_id

int member_id

An integer that uniquely identifies the data member within this com.rti.dds.dynamicdata.DynamicData sample's type.

The member ID is assigned automatically by the middleware based on the member's declaration order within the type. It is a 1-based index of the member's position in the type.

See also

com.rti.dds.typecode.TCKind

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().

member_name

String member_name

The string name of the data member.

This name will be unique among members of the same type. However, a single named member may have multiple type representations.

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().

member_exists

boolean member_exists

Indicates whether the member exists in this sample.

A member that is defined in a type may not exist in a sample of that type in the following situations

• The member is optional and is unset
• Being part of a union, the discriminator doesn't select this member
• When getting the information about a sequence element, with index i, and i is greater than the current sequence length but smaller than its maximum length.

See also

com.rti.dds.dynamicdata.DynamicData.member_exists_in_type

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().

member_kind

TCKind member_kind

The kind of type of this data member (e.g., integer, structure, etc.).

This is a convenience field; it is equivalent to looking up the member in the com.rti.dds.typecode.TypeCode and getting the com.rti.dds.typecode.TCKind from there.

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().

element_count

int element_count

The number of elements within this data member.

This information is only valid for members of array or sequence types. Members of other types will always report zero (0) here.

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().

element_kind

TCKind element_kind

The kind of type of the elements within this data member.

This information is only valid for members of array or sequence types. Members of other types will always report com.rti.dds.typecode.TCKind.TK_NULL here.

Referenced by DynamicDataMemberInfo.DynamicDataMemberInfo().