#include <DynamicType.hpp>
Public Types | |
using | _ref_type = typename traits< DynamicType >::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 (see [standard] 7.5.2.8.7) | |
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 the member that corresponds to the specified name. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_all_members_by_name (DynamicTypeMembersByName &member)=0 |
Returns all members by ObjectName. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_member (traits< DynamicTypeMember >::ref_type &member, MemberId id)=0 |
Returns the member that corresponds to the specified MemberId. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_all_members (DynamicTypeMembersById &member)=0 |
Returns all members 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 |
Returns the number of applied annotations to the type. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_annotation (traits< AnnotationDescriptor >::ref_type &descriptor, uint32_t idx)=0 |
Returns an applied annotation by index. | |
virtual FASTDDS_EXPORTED_API uint32_t | get_verbatim_text_count ()=0 |
Returns the number of applied verbatim text to the type. | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_verbatim_text (traits< VerbatimTextDescriptor >::ref_type &descriptor, uint32_t idx)=0 |
Returns an applied verbatim text by index. | |
virtual FASTDDS_EXPORTED_API bool | equals (traits< DynamicType >::ref_type other)=0 |
State comparison according with the [standard] sections 7.5.2.8.4. | |
Protected Member Functions | |
DynamicType ()=default | |
virtual | ~DynamicType ()=default |
traits< DynamicType >::ref_type | _this () |
using _ref_type = typename traits<DynamicType>::ref_type |
|
protecteddefault |
|
protectedvirtualdefault |
|
protected |
|
pure virtual |
State comparison according with the [standard] sections 7.5.2.8.4.
[in] | other | DynamicType reference to compare to |
true
on equality
|
pure virtual |
Returns all members by MemberId.
[in,out] | member | DynamicTypeMembersById reference where the information is copied. |
RETCODE_OK |
|
pure virtual |
Returns all members by ObjectName.
[in,out] | member | DynamicTypeMembersByName reference where the information is copied. |
RETCODE_OK |
|
pure virtual |
Returns an applied annotation by index.
[in,out] | descriptor | AnnotationDescriptor reference where the information is copied. |
[in] | idx | Index. |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil or index is out-of-range. |
|
pure virtual |
Returns the number of applied annotations to the type.
|
pure virtual |
Provides a summary of the state of this type overwriting a provided object (see [standard] 7.5.2.8.7)
[in,out] | descriptor | TypeDescriptor reference where copied the information. |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil. |
|
pure virtual |
|
pure virtual |
Returns the member that corresponds to the specified MemberId.
[in,out] | member | DynamicTypeMember reference used to return the reference to the member. |
[in] | id | MemberId |
RETCODE_OK | when the member was found. |
RETCODE_BAD_PARAMETER | when the member doesn't exist. |
|
pure virtual |
This operation returns the member that corresponds to the specified index.
[in,out] | member | DynamicTypeMember reference used to return the reference to the member. |
[in] | index | Index |
RETCODE_OK | when the member was found. |
RETCODE_BAD_PARAMETER | when the index is out-of-range. |
|
pure virtual |
Returns the member that corresponds to the specified name.
[in,out] | member | DynamicTypeMember reference used to return the reference to the member. |
[in] | name | Member name of the member being queried. |
RETCODE_OK | when the member was found. |
RETCODE_BAD_PARAMETER | when the member doesn't exist. |
|
pure virtual |
This operation returns the current number of members.
|
pure virtual |
Returns the fully qualified name of this type.
|
pure virtual |
Returns an applied verbatim text by index.
[in,out] | descriptor | VerbatimTextDescriptor reference where the information is copied. |
[in] | idx | Index. |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil or index is out-of-range. |
|
pure virtual |
Returns the number of applied verbatim text to the type.