CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
TypeDescriptor Class Referenceabstract

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

Inheritance diagram for TypeDescriptor:
TypeDescriptor

Properties

abstract short kind [get, set]
 the 'kind' of this type
 
abstract String name [get, set]
 the 'name' of this type
 
abstract org.omg.dds.DynamicType base_type [get, set]
 the 'base_type' of this type More...
 
abstract org.omg.dds.DynamicType discriminator_type [get, set]
 If this descriptor represents a union type, this field indicates the type of the union's descriminator.
 
abstract uint [] bound [get, set]
 The bound property indicates the bound of collection and similar types. More...
 
abstract org.omg.dds.DynamicType element_type [get, set]
 If this descriptor represents an array, sequence, or string type, this property indicates the element type of the collection. More...
 
abstract org.omg.dds.DynamicType key_element_type [get, set]
 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.

Property Documentation

◆ base_type

abstract org.omg.dds.DynamicType base_type
getset

the 'base_type' of this type

  • If this descriptor represents a structure type, base_type indicates the supertype of that type. A nil value of this property indicates that the structure type has no supertype.
  • If this descriptor represents an alias type, base_type indicates the type being aliased. A nil value for this property is not considered consistent.

In all other cases, a consistent descriptor shall have a nil value for this property.

◆ bound

abstract uint [] bound
getset

The bound property indicates the bound of collection and similar types.

  • If this descriptor represents an array type, the length of the property value indicates the number of dimensions in the array, and each value indicates the bound of the corresponding dimension.
  • If this descriptor represents a sequence, map, bit set, or string type, the length of the property value is one and the integral value in that property indicates the bound of the collection.

In all other cases, a consistent descriptor shall have a nil value for this property.

◆ element_type

abstract org.omg.dds.DynamicType element_type
getset

If this descriptor represents an array, sequence, or string type, this property indicates the element type of the collection.

It must not be nil for the descriptor to be consistent. If this descriptor represents a map type, this property indicates the value element type of the map. It must not be nil for the descriptor to be consistent.

If this descriptor represents a bit set type, this property must indicate a Boolean type for the descriptor to be consistent.

If this descriptor represents any other kind of type, this property must be nil for the descriptor to be consistent.

◆ key_element_type

abstract org.omg.dds.DynamicType key_element_type
getset

If this descriptor represents a map type, this property indicates the value element type of the map.

It must not be nil for the descriptor to be consistent.

 If this descriptor represents any other kind of type, this 
 property must be nil for the descriptor to be consistent.

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