RTI Connext Java API  Version 5.1.0
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.
 
 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.
 
- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 

Public Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from Struct
 Struct ()
 
abstract void pull_from_nativeI (long native_status)
 
abstract void push_to_nativeI (long native_status)
 

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

int member_id

An integer that uniquely identifies the data member within this com.rti.dds.dynamicdata.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
com.rti.dds.typecode.TCKind
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.

boolean member_exists

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

For non-sparse data types, this value will always be com.rti.dds.infrastructure.true.

See Also
com.rti.dds.typecode.TCKind
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.

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.

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.


RTI Connext Java API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc