MemberDescriptor Class Reference

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

Inheritance diagram for MemberDescriptor:

Public Member Functions
override ReturnCode_t	copy_from (DDS_MemberDescriptor descriptor)
	Overwrite the contents of the 'to' descriptor with those of the provided 'from' descriptor. More...
override bool	equals (DDS_MemberDescriptor descriptor)
	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 MemberDescriptor
abstract String	name [get, set]
	the 'name' of this member
abstract uint	id [get, set]
	the 'id' of this member
abstract org.omg.dds.DynamicType	type [get, set]
	the 'type' of this member
abstract String	default_value [get, set]
	the default value of this member
abstract uint	index [get, set]
	the index of this member
abstract int []	label [get, set]
	If this is the member of a union, then this sequence contains all values that can select this union case.
abstract bool	default_label [get, set]
	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()

override ReturnCode_t copy_from ( DDS_MemberDescriptor  descriptor )

inlinevirtual

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

Implements MemberDescriptor.

equals()

override bool equals ( DDS_MemberDescriptor  descriptor )

inlinevirtual

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.

Implements MemberDescriptor.

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