CoreDX DDS C++ Reference Manual
Public Member Functions | Protected Member Functions | List of all members
DDS::DynamicTypeMember Class Referenceabstract

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

Public Member Functions

virtual ReturnCode_t get_descriptor (class MemberDescriptor *descriptor)=0
 This operation accesses the current state of this type. More...
 
virtual unsigned int get_annotation_count ()=0
 Return the number of annotations applied to this type. More...
 
virtual ReturnCode_t get_annotation (class AnnotationDescriptor *descriptor, const unsigned int idx)=0
 Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
 
virtual unsigned char equals (const class DynamicTypeMember *other)=0
 Compare two DynamicTypeMember's. More...
 
virtual MemberId get_id ()=0
 This convenience operation provides the member ID of this member. More...
 
virtual const char * get_name ()=0
 This convenience operation provides the name of this member. More...
 
virtual MemberFlag get_flags ()=0
 Access the type flags.
 
virtual ReturnCode_t set_flags (MemberFlag f)=0
 Set the type flags.
 

Protected Member Functions

 DynamicTypeMember ()
 

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

Constructor & Destructor Documentation

DDS::DynamicTypeMember::DynamicTypeMember ( )
protected

Constructor, Copy Constructor, Destructor, Assignment operator

Member Function Documentation

virtual unsigned char DDS::DynamicTypeMember::equals ( const class DynamicTypeMember other)
pure virtual

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.

virtual ReturnCode_t DDS::DynamicTypeMember::get_annotation ( class AnnotationDescriptor descriptor,
const unsigned int  idx 
)
pure virtual

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.
virtual unsigned int DDS::DynamicTypeMember::get_annotation_count ( )
pure virtual

Return the number of annotations applied to this type.

Return values
uintthe number of annotations
Not Yet Supported:
This operation is not yet implemented.
virtual ReturnCode_t DDS::DynamicTypeMember::get_descriptor ( class MemberDescriptor descriptor)
pure virtual

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
virtual MemberId DDS::DynamicTypeMember::get_id ( )
pure virtual

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.

virtual const char* DDS::DynamicTypeMember::get_name ( )
pure virtual

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-2017 Twin Oaks Computing, Inc
Castle Rock, CO 80108
All rights reserved.