#include <DynamicTypeBuilder.hpp>
Public Types | |
using | _ref_type = typename traits< DynamicTypeBuilder >::ref_type |
Public Member Functions | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_descriptor (traits< TypeDescriptor >::ref_type &descriptor)=0 |
Provides a summary of the state of this type overwriting a provided object. | |
virtual FASTDDS_EXPORTED_API ObjectName | get_name ()=0 |
Returns the fully qualified name of this type. | |
virtual FASTDDS_EXPORTED_API TypeKind | get_kind ()=0 |
Returns the TypeKind associated. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_member_by_name (traits< DynamicTypeMember >::ref_type &member, const ObjectName &name)=0 |
Returns a member looked for by name. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_all_members_by_name (DynamicTypeMembersByName &member)=0 |
Returns all members sorted by name. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_member (traits< DynamicTypeMember >::ref_type &member, MemberId id)=0 |
Returns a member looked for by MemberId. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_all_members (DynamicTypeMembersById &member)=0 |
Returns all members sorted by MemberId. | |
virtual FASTDDS_EXPORTED_API uint32_t | get_member_count ()=0 |
This operation returns the current number of members. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_member_by_index (traits< DynamicTypeMember >::ref_type &member, uint32_t index)=0 |
This operation returns the member that corresponds to the specified index. | |
virtual FASTDDS_EXPORTED_API uint32_t | get_annotation_count ()=0 |
This operation returns the current number of annotations to the type. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_annotation (traits< AnnotationDescriptor >::ref_type &descriptor, uint32_t idx)=0 |
This operation returns the annotation that corresponds to the specified index. | |
virtual FASTDDS_EXPORTED_API bool | equals (traits< DynamicType >::ref_type other)=0 |
Compares current state against a DynamicType reference. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | add_member (traits< MemberDescriptor >::ref_type descriptor)=0 |
Adds a 'member' to this type, where the new 'member' has the meaning defined in the specification of the DynamicTypeMember class. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | apply_annotation (traits< AnnotationDescriptor >::ref_type descriptor)=0 |
Apply the given annotation to this type. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | apply_annotation_to_member (MemberId member_id, traits< AnnotationDescriptor >::ref_type descriptor)=0 |
Apply the given annotation to a member of this type. | |
virtual FASTDDS_EXPORTED_API traits< DynamicType >::ref_type | build ()=0 |
Create an immutable DynamicType object containing a snapshot of this builder's current state. | |
Protected Member Functions | |
DynamicTypeBuilder ()=default | |
virtual | ~DynamicTypeBuilder ()=default |
traits< DynamicTypeBuilder >::ref_type | _this () |
using _ref_type = typename traits<DynamicTypeBuilder>::ref_type |
|
protecteddefault |
|
protectedvirtualdefault |
|
protected |
|
pure virtual |
Adds a 'member' to this type, where the new 'member' has the meaning defined in the specification of the DynamicTypeMember class.
[in] | descriptor | MemberDescriptor reference used for the new member. |
RETCODE_OK | when the member was created successfully. |
RETCODE_BAD_PARAMETER | when there is an inconsistency. |
RETCODE_PRECONDITION_NOT_MET | when the type does not have members. |
|
pure virtual |
Apply the given annotation to this type.
[in] | descriptor | AnnotationDescriptor reference to be applied. |
RETCODE_OK | when the annotation was applied successful. |
RETCODE_BAD_PARAMETER | when there is an inconsistency. |
|
pure virtual |
Apply the given annotation to a member of this type.
[in] | member_id | Member identifier. |
[in] | descriptor | AnnotationDescriptor reference to be applied. |
RETCODE_OK | when the annotation was applied successful. |
RETCODE_BAD_PARAMETER | when there is an inconsistency. |
|
pure virtual |
Create an immutable DynamicType object containing a snapshot of this builder's current state.
|
pure virtual |
Compares current state against a DynamicType reference.
[in] | other | DynamicType reference to compare to. |
true
on equality
|
pure virtual |
Returns all members sorted by MemberId.
[in,out] | member | DynamicTypeMemberById reference used to return all members. |
RETCODE_OK | always. |
|
pure virtual |
Returns all members sorted by name.
[in,out] | member | DynamicTypeMemberByName reference used to return all members. |
RETCODE_OK | always. |
|
pure virtual |
This operation returns the annotation that corresponds to the specified index.
[in,out] | descriptor | AnnotationDescriptor reference where information is copied. |
[in] | idx | Index |
RETCODE_OK | when member was found. |
RETCODE_BAD_PARAMETER | when reference is nil or index is out-of-range. |
|
pure virtual |
This operation returns the current number of annotations to the type.
|
pure virtual |
Provides a summary of the state of this type overwriting a provided object.
[in,out] | descriptor | TypeDescriptor |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil. |
|
pure virtual |
|
pure virtual |
Returns a member looked for by MemberId.
[in,out] | member | DynamicTypeMember reference used to return the member. |
[in] | id | Member identifier. |
RETCODE_OK | when member was found. |
RETCODE_BAD_PARAMETER | when member wasn't found. |
|
pure virtual |
This operation returns the member that corresponds to the specified index.
[in,out] | member | DynamicTypeMember reference used to return the member. |
[in] | index | Index |
RETCODE_OK | when member was found. |
RETCODE_BAD_PARAMETER | when index is out-of-range. |
|
pure virtual |
Returns a member looked for by name.
[in,out] | member | DynamicTypeMember reference used to return the member. |
[in] | name | Member name. |
RETCODE_OK | when member was found. |
RETCODE_BAD_PARAMETER | when member wasn't found. |
|
pure virtual |
This operation returns the current number of members.
|
pure virtual |
Returns the fully qualified name of this type.