com.toc.coredx.dynamictype.DynamicType Class Reference

An instance of DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on. More...

Inherits DDS.DynamicType.

Public Member Functions
ReturnCode_t	get_descriptor (DDS.TypeDescriptorHolder descriptor)
	This operation provides a summary of the current state of this type. More...
String	get_name ()
	This convenience operation provides the fully qualified name of this type. More...
short	get_kind ()
	This convenience operation returns the kind of this type (e.g., integer, structure, etc.). More...
ReturnCode_t	get_member_by_name (DDS.DynamicTypeMemberHolder member, String name)
	This operation accesses a member by name. More...
ReturnCode_t	get_all_members_by_name (DDS.DynamicTypeMembersByNameHolder member)
	This operation provides access to the 'members_by_name' map. More...
ReturnCode_t	get_member (DDS.DynamicTypeMemberHolder member, int id)
	This operation accesses a member by id. More...
ReturnCode_t	get_all_members (DDS.DynamicTypeMembersByIdHolder member)
	This operation provides access to the 'members_by_id' map. More...
int	get_annotation_count ()
	Return the number of annotations applied to this type. More...
ReturnCode_t	get_annotation (DDS.AnnotationDescriptorHolder descriptor, int idx)
	Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation. More...
boolean	equals (DDS.DynamicType tother)
	Two types shall be considered equal if and only if all of their respective properties are equal. More...

Detailed Description

An instance of DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on.

See also

DynamicTypeSupport

DynamicTypeBuilderFactory

DynamicTypeBuilder

Member Function Documentation

equals()

boolean com.toc.coredx.dynamictype.DynamicType.equals

(

DDS.DynamicType

tother

)

Two types shall be considered equal if and only if all of their respective properties are equal.

Return values

true	if not equal
false	if equal

get_all_members()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_all_members

(

DDS.DynamicTypeMembersByIdHolder

member

)

This operation provides access to the 'members_by_id' map.

Return values

RETCODE_PRECONDITION_NOT_MET	if the type does not have members
RETCODE_BAD_PARAMETER	in the case of an invalid parameter
RETCODE_OK	on success

get_all_members_by_name()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_all_members_by_name

(

DDS.DynamicTypeMembersByNameHolder

member

)

This operation provides access to the 'members_by_name' map.

Return values

RETCODE_PRECONDITION_NOT_MET	if the type does not have members
RETCODE_BAD_PARAMETER	in the case of an invalid parameter
RETCODE_OK	on success

get_annotation()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_annotation	(	DDS.AnnotationDescriptorHolder	descriptor,
		int	idx
	)

Access an annotation at the specified index. On success, the 'descriptor' parameter is set to the annotation.

Not Yet Supported:

This operation is not yet implemented.

get_annotation_count()

int com.toc.coredx.dynamictype.DynamicType.get_annotation_count

(

)

Return the number of annotations applied to this type.

Return values

uint	the number of annotations

Not Yet Supported:

This operation is not yet implemented.

get_descriptor()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_descriptor

(

DDS.TypeDescriptorHolder

descriptor

)

This operation provides a summary of the current state of this type.

It populates the provided 'descriptor' parameter.

Return values

RETCODE_BAD_PARAMETER	if any parameters are invalid
RETCODE_OK	on success

get_kind()

short com.toc.coredx.dynamictype.DynamicType.get_kind

(

)

This convenience operation returns the kind of this type (e.g., integer, structure, etc.).

Its result shall be the kind indicated by the type’s descriptor property.

get_member()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_member	(	DDS.DynamicTypeMemberHolder	member,
		int	id
	)

This operation accesses a member by id.

Several types are considered to have 'members"

• structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the member that has a matching member id.

Return values

RETCODE_PRECONDITION_NOT_MET	if the type does not have members
RETCODE_BAD_PARAMETER	in the case of an invalid parameter
RETCODE_ERROR	if the member id is not present in the type
RETCODE_OK	on success

get_member_by_name()

ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_member_by_name	(	DDS.DynamicTypeMemberHolder	member,
		String	name
	)

This operation accesses a member by name.

Several types are considered to have 'members"

• structures, unions, enumerations, annotations, and bitsets

On success, the 'member' parameter is set to the named member.

Return values

RETCODE_PRECONDITION_NOT_MET	if the type does not have members
RETCODE_BAD_PARAMETER	in the case of an invalid parameter
RETCODE_ERROR	if the named member is not present in the type
RETCODE_OK	on success

get_name()

String com.toc.coredx.dynamictype.DynamicType.get_name

(

)

This convenience operation provides the fully qualified name of this type.

It is identical to the name string that is a member of the descriptor property.