19.1.6.1.8. DynamicTypeMember

class DynamicTypeMember : public std::enable_shared_from_this<DynamicTypeMember>

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.

Public Functions

virtual 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)

Parameters:

descriptor – [inout] MemberDescriptor reference where the information is copied.

Return values:

  • RETCODE_OK – when the copy was successful.

  • RETCODE_BAD_PARAMETER – when descriptor reference is nil.

Returns:

standard ReturnCode_t

virtual uint32_t get_annotation_count() = 0

Returns the number of applied annotations to the member.

Returns:

Number of annotations.

virtual ReturnCode_t get_annotation(traits<AnnotationDescriptor>::ref_type &descriptor, uint32_t idx) = 0

Returns an applied annotation by index.

Parameters:

  • descriptor – [inout] AnnotationDescriptor reference where the information is copied.

  • idx – [in] Index.

Return values:

  • RETCODE_OK – when the copy was successful.

  • RETCODE_BAD_PARAMETER – when descriptor reference is nil or index is out-of-range.

Returns:

standard ReturnCode_t

virtual uint32_t get_verbatim_text_count() = 0

Returns the number of applied verbatim text to the member.

Returns:

Number of verbatim texts.

virtual ReturnCode_t get_verbatim_text(traits<VerbatimTextDescriptor>::ref_type &descriptor, uint32_t idx) = 0

Returns an applied verbatim text by index.

Parameters:

  • descriptor – [inout] VerbatimTextDescriptor reference where the information is copied.

  • idx – [in] Index.

Return values:

  • RETCODE_OK – when the copy was successful.

  • RETCODE_BAD_PARAMETER – when descriptor reference is nil or index is out-of-range.

Returns:

standard ReturnCode_t

virtual bool equals(traits<DynamicTypeMember>::ref_type other) = 0

State comparison according with the [standard] sections 7.5.2.6.3

Parameters:

other – [in] DynamicTypeMember reference to compare to

Returns:

bool true on equality

virtual MemberId get_id() = 0

Getter for id property according with the [standard] section 7.5.2.6.4

Returns:

MemberId

virtual ObjectName get_name() = 0

Returns the name of this member.

Returns:

Member name.