Represents a "member" of a type. More...
#include <DynamicTypeMember.hpp>
Public Types | |
using | _ref_type = typename traits< DynamicTypeMember >::ref_type |
Public Member Functions | |
virtual FASTDDS_EXPORTED_API ReturnCode_t | get_descriptor (traits< MemberDescriptor >::ref_type &descriptor)=0 |
Provides a summary of the state of this type overwriting a provided object (see [standard] 7.5.2.6.2) | |
virtual FASTDDS_EXPORTED_API uint32_t | get_annotation_count ()=0 |
Returns the number of applied annotations to the member. | |
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 member. | |
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< DynamicTypeMember >::ref_type other)=0 |
State comparison according with the [standard] sections 7.5.2.6.3. | |
virtual FASTDDS_EXPORTED_API MemberId | get_id ()=0 |
Getter for id property according with the [standard] section 7.5.2.6.4. | |
virtual FASTDDS_EXPORTED_API ObjectName | get_name ()=0 |
Returns the name of this member. | |
Protected Member Functions | |
DynamicTypeMember ()=default | |
virtual | ~DynamicTypeMember ()=default |
traits< DynamicTypeMember >::ref_type | _this () |
Represents a "member" of a type.
A "member" in this sense may be a member of an aggregated type, a constant within an enumeration, or some other type substructure.
using _ref_type = typename traits<DynamicTypeMember>::ref_type |
|
protecteddefault |
|
protectedvirtualdefault |
|
protected |
|
pure virtual |
State comparison according with the [standard] sections 7.5.2.6.3.
[in] | other | DynamicTypeMember reference to compare to |
true
on equality
|
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 member.
|
pure virtual |
Provides a summary of the state of this type overwriting a provided object (see [standard] 7.5.2.6.2)
[in,out] | descriptor | MemberDescriptor reference where the information is copied. |
RETCODE_OK | when the copy was successful. |
RETCODE_BAD_PARAMETER | when descriptor reference is nil. |
|
pure virtual |
Getter for id property according with the [standard] section 7.5.2.6.4.
|
pure virtual |
Returns the name of this member.
|
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 member.