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

#include <managed_dynamicdata.h>

Properties
System::Int32	member_id `[get]`
	An integer that uniquely identifies the data member within this DDS::DynamicData sample's type. More...

System::String^	member_name `[get]`
	The string name of the data member. More...

System::Boolean	member_exists `[get]`
	Indicates whether the member exists in this sample. More...

TCKind	member_kind `[get]`
	The kind of type of this data member (e.g., integer, structure, etc.). More...

System::UInt32	element_count `[get]`
	The number of elements within this data member. More...

TCKind	element_kind `[get]`
	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: DDS::DynamicData::get_member_info

Property Documentation

◆ member_id

System:: Int32 DDS::DynamicDataMemberInfo::member_id

get

An integer that uniquely identifies the data member within this DDS::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: DDS::TCKind

◆ member_name

System:: String^ DDS::DynamicDataMemberInfo::member_name

get

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.

◆ member_exists

System:: Boolean DDS::DynamicDataMemberInfo::member_exists

get

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: DDS::DynamicData::member_exists_in_type

◆ member_kind

TCKind DDS::DynamicDataMemberInfo::member_kind

get

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 DDS::TypeCode and getting the DDS::TCKind from there.

◆ element_count

System:: UInt32 DDS::DynamicDataMemberInfo::element_count

get

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.

◆ element_kind

TCKind DDS::DynamicDataMemberInfo::element_kind

get

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 TK_NULL here.

Properties