An instance of DynamicType represent a type’s schema: its physical name, kind, member definitions (if any), and so on.
More...
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
◆ DynamicType()
| DDS::DynamicType::DynamicType |
( |
| ) |
|
|
protected |
Constructor, Copy Constructor, Destructor, Assignment operator
◆ equals()
| virtual unsigned char DDS::DynamicType::equals |
( |
const class DynamicType * |
other | ) |
|
|
pure virtual |
Two types shall be considered equal if and only if all of their respective properties are equal.
- Return values
-
| zero | if not equal |
| non-zero | if equal |
◆ get_all_members()
| virtual ReturnCode_t DDS::DynamicType::get_all_members |
( |
DynamicTypeMembersById * |
member | ) |
const |
|
pure virtual |
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()
| virtual ReturnCode_t DDS::DynamicType::get_all_members_by_name |
( |
DynamicTypeMembersByName * |
member | ) |
const |
|
pure virtual |
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()
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()
| virtual uint32_t DDS::DynamicType::get_annotation_count |
( |
| ) |
|
|
pure virtual |
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()
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()
| virtual TypeKind DDS::DynamicType::get_kind |
( |
| ) |
|
|
pure virtual |
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()
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()
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()
| virtual const char* DDS::DynamicType::get_name |
( |
| ) |
|
|
pure virtual |
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.
