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

A TypeDescriptor comprises the state of a type. More...

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

Public Member Functions

ReturnCode_t copy_from (DDS.TypeDescriptor other)
 Overwrite the contents of this descriptor with those of another descriptor. More...
 
boolean equals (DDS.TypeDescriptor other)
 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.TypeDescriptor
short kind
 the 'kind' of this type
 
String name
 the 'name' of this type
 
DynamicType base_type
 the 'base_type' of this type More...
 
DynamicType discriminator_type
 If this descriptor represents a union type, this field indicates the type of the union's descriminator.
 
int [] bound
 The bound property indicates the bound of collection and similar types. More...
 
DynamicType element_type
 If this descriptor represents an array, sequence, or string type, this property indicates the element type of the collection. More...
 
DynamicType key_element_type
 If this descriptor represents a map type, this property indicates the value element type of the map. More...
 

Detailed Description

A TypeDescriptor comprises the state of a type.

Member Function Documentation

◆ copy_from()

ReturnCode_t com.toc.coredx.dynamictype.TypeDescriptor.copy_from ( DDS.TypeDescriptor  other)

Overwrite the contents of this descriptor with those of another descriptor.

Subsequent calls to equals, passing the same argument as to this method, return true. The other 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.TypeDescriptor.equals ( DDS.TypeDescriptor  other)

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