A DynamicTypeBuilder object represents the state of a particular type defined according to the Type System. It is used to instantiate concrete DynamicType objects.
More...
A DynamicTypeBuilder object represents the state of a particular type defined according to the Type System. It is used to instantiate concrete DynamicType objects.
- See also
- DynamicType
-
DynamicTypeBuilderFactory
-
DynamicTypeSupport
DDS::DynamicTypeBuilder::DynamicTypeBuilder |
( |
| ) |
|
|
protected |
Constructor, Copy Constructor, Destructor, Assignment operator
Add a member to the type.
- Return values
-
RETCODE_PRECONDITION_NOT_MET | if the type does not have members or a member with the same id already exists |
RETCODE_BAD_PARAMETER | in the case of an invalid parameter |
RETCODE_OUT_OF_RESOURCES | in the case of a memory shortage |
RETCODE_OK | on success |
Apply the given annotation to this type.
Parameter descriptor - A consistent descriptor for the annotation to apply.
- Return values
-
RETCODE_BAD_PARAMETER | If this 'descriptor' parameter is not consistent |
- Not Yet Supported:
- This operation is not yet implemented.
virtual class DynamicType* DDS::DynamicTypeBuilder::build |
( |
| ) |
|
|
pure virtual |
Create an immutable DynamicType object defined by the builder's current state.
Subsequent changes to this builder, if any, shall have no effect on the state of any previously created DynamicType.
- Return values
-
nil | in the case of an error |
Destroy the type information contained in this DynamicTypeBuilder instance.
- Return values
-
RETCODE_BAD_PARAMETER | in the case of an invalid parameter |
RETCODE_OK | on success |
virtual unsigned char DDS::DynamicTypeBuilder::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 |
virtual ReturnCode_t DDS::DynamicTypeBuilder::get_all_members |
( |
DynamicTypeMembersById * |
member | ) |
|
|
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 |
DDRETCODE_OK | on success |
virtual ReturnCode_t DDS::DynamicTypeBuilder::get_all_members_by_name |
( |
DynamicTypeMembersByName * |
member | ) |
|
|
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 |
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.
virtual unsigned int DDS::DynamicTypeBuilder::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.
This operation provides a summary of the state of this type.
It overwrites the state of the application-provided 'descriptor' object.
- Return values
-
RETCODE_BAD_PARAMETER | if the descriptor parameter is invalid |
RETCODE_OK | on success |
virtual TypeKind DDS::DynamicTypeBuilder::get_kind |
( |
| ) |
|
|
pure virtual |
This convenience operation indicates the kind of this type (e.g., integer, structure, etc.).
Its result shall be the same as the kind indicated by the type’s descriptor property.
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 |
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 |
virtual const char* DDS::DynamicTypeBuilder::get_name |
( |
| ) |
|
|
pure virtual |
This convenience operation provides the fully qualified name of this type. I.
t shall be identical to the name string that is a member of the descriptor property.