CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
com.toc.coredx.dynamictype.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 DDS.DynamicTypeMember.

Public Member Functions

ReturnCode_t get_descriptor (DDS.MemberDescriptorHolder descriptor)
 This operation accesses the current state of this type. More...
 
int get_annotation_count ()
 Return the number of annotations applied to this type. More...
 
ReturnCode_t get_annotation (DDS.AnnotationDescriptorHolder descriptor, int idx)
 Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
 
boolean equals (DDS.DynamicTypeMember other)
 Compare two DynamicTypeMember's. More...
 
int 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()

boolean com.toc.coredx.dynamictype.DynamicTypeMember.equals ( DDS.DynamicTypeMember  other)

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 com.toc.coredx.dynamictype.DynamicTypeMember.get_annotation ( DDS.AnnotationDescriptorHolder  descriptor,
int  idx 
)

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()

int com.toc.coredx.dynamictype.DynamicTypeMember.get_annotation_count ( )

Return the number of annotations applied to this type.

Return values
uintthe number of annotations
Not Yet Supported:
This operation is not yet implemented.

◆ get_descriptor()

ReturnCode_t com.toc.coredx.dynamictype.DynamicTypeMember.get_descriptor ( DDS.MemberDescriptorHolder  descriptor)

This operation accesses the current state of this type.

It overwrites the application-provided 'descriptor' parameter.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter

◆ get_id()

int com.toc.coredx.dynamictype.DynamicTypeMember.get_id ( )

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 com.toc.coredx.dynamictype.DynamicTypeMember.get_name ( )

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.


© 2009-2020 Twin Oaks Computing, Inc
Castle Rock, CO 80104
All rights reserved.