RTI Connext .Net APIs  Version 5.0.0
DDS::DynamicDataMemberInfo Class Reference

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.
 
System::String^  member_name [get]
 The string name of the data member.
 
System::Boolean member_exists [get]
 Indicates whether the corresponding member of the data type actually exists in this sample.
 
TCKind member_kind [get]
 The kind of type of this data member (e.g. integer, structure, etc.).
 
System::UInt32 element_count [get]
 The number of elements within this data member.
 
TCKind element_kind [get]
 The kind of type of the elements within this data member.
 

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

System:: Int32 DDS::DynamicDataMemberInfo::member_id
get

An integer that uniquely identifies the data member within this DDS::DynamicData sample's type.

For sparse data types, this value will be assigned by the type designer. For types defined in IDL, it will be assigned automatically by the middleware based on the member's declaration order within the type.

See Also
::DDS::TCKind
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.

System:: Boolean DDS::DynamicDataMemberInfo::member_exists
get

Indicates whether the corresponding member of the data type actually exists in this sample.

For non-sparse data types, this value will always be true.

See Also
::DDS::TCKind
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.

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.

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 ::DDS::TCKind::TK_NULL here.


RTI Connext .Net APIs Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc