CoreDX Data Distribution Service
The High Performance, Small Footprint DDS from Twin Oaks Computing, Inc
|
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... | |
An instance of DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on.
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.
true | if not equal |
false | if equal |
ReturnCode_t com.toc.coredx.dynamictype.DynamicType.get_all_members | ( | DDS.DynamicTypeMembersByIdHolder | member | ) |
This operation provides access to the 'members_by_id' map.
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 |
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.
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 |
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.
int com.toc.coredx.dynamictype.DynamicType.get_annotation_count | ( | ) |
Return the number of annotations applied to this type.
uint | the number of annotations |
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.
RETCODE_BAD_PARAMETER | if any parameters are invalid |
RETCODE_OK | on success |
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.
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"
On success, the 'member' parameter is set to the member that has a matching member id.
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 |
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"
On success, the 'member' parameter is set to the named member.
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 |
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.