TypeDescriptor Class Reference

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

Inheritance diagram for TypeDescriptor:

Public Member Functions
override ReturnCode_t	copy_from (org.omg.dds.TypeDescriptor other)
	Overwrite the contents of this descriptor with those of another descriptor. More...
override bool	equals (org.omg.dds.TypeDescriptor other)
	Compare two TypeDescriptor's. More...
override bool	is_consistent ()
	Indicates whether the states of all of this descriptor’s properties are consistent. More...

Additional Inherited Members
Properties inherited from TypeDescriptor
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.

Member Function Documentation

copy_from()

override ReturnCode_t copy_from ( org.omg.dds.TypeDescriptor  other )

inline

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_PARAMETER	in the case of an invalid parameter
RETCODE_ERROR	in the case of any other error

equals()

override bool equals ( org.omg.dds.TypeDescriptor  other )

inline

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

override bool is_consistent ( )

inlinevirtual

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-zero	if descriptor is consistent
zero	if descriptor is not consistent

Implements TypeDescriptor.