CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
com.toc.coredx.dynamictype.MemberDescriptor Class Reference

A MemberDescriptor comprises the state of a DynamicTypeMember. More...

Inheritance diagram for com.toc.coredx.dynamictype.MemberDescriptor:
DDS.MemberDescriptor

Public Member Functions

ReturnCode_t copy_from (DDS.MemberDescriptor descriptor)
 Overwrite the contents of the 'to' descriptor with those of the provided 'from' descriptor. More...
 
boolean equals (DDS.MemberDescriptor descriptor)
 Compare two TypeDescriptor's. More...
 
boolean is_consistent ()
 Indicates whether the states of all of this descriptor’s properties are consistent. More...
 

Additional Inherited Members

- Public Attributes inherited from DDS.MemberDescriptor
String name
 the 'name' of this member
 
int id
 the 'id' of this member
 
DynamicType type
 the 'type' of this member
 
String default_value
 the default value of this member
 
int index
 the index of this member
 
int [] label
 If this is the member of a union, then this sequence contains all values that can select this union case.
 
boolean default_label
 If this is the member of a union, then this flag indicates if it is selected when the union discriminator value does not match a label value of any union member.
 

Detailed Description

A MemberDescriptor comprises the state of a DynamicTypeMember.

Member Function Documentation

◆ copy_from()

ReturnCode_t com.toc.coredx.dynamictype.MemberDescriptor.copy_from ( DDS.MemberDescriptor  descriptor)

Overwrite the contents of the 'to' descriptor with those of the provided 'from' descriptor.

Subsequent calls to equals, passing the same argument as to this method, return true.

The 'from' descriptor shall not be changed by this operation.

Return values
RETCODE_BAD_PARAMETERin the case of an invalid parameter
RETCODE_ERRORin the case of any other error

◆ equals()

boolean com.toc.coredx.dynamictype.MemberDescriptor.equals ( DDS.MemberDescriptor  descriptor)

Compare two TypeDescriptor's.

Two type descriptors are considered equal if and only if the values of all of the properties identified in the table above are equal in each of them.

◆ is_consistent()

boolean com.toc.coredx.dynamictype.MemberDescriptor.is_consistent ( )

Indicates whether the states of all of this descriptor’s properties are consistent.

The definitions of consistency for each property are given in the section corresponding to that property.

Return values
non-zeroif descriptor is consistent
zeroif descriptor is not consistent

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