Fast RTPS  Version 2.14.1
Fast RTPS
Loading...
Searching...
No Matches
DynamicType Class Reference

#include <DynamicType.h>

Public Member Functions

RTPS_DllAPI bool equals (const DynamicType *other) const
 
RTPS_DllAPI ReturnCode_t get_all_members (std::map< MemberId, DynamicTypeMember * > &members)
 
RTPS_DllAPI ReturnCode_t get_all_members_by_name (std::map< std::string, DynamicTypeMember * > &members)
 
RTPS_DllAPI uint32_t get_bounds (uint32_t index=0) const
 
RTPS_DllAPI uint32_t get_bounds_size () const
 
RTPS_DllAPI ReturnCode_t get_descriptor (TypeDescriptor *descriptor) const
 
RTPS_DllAPI const TypeDescriptorget_descriptor () const
 
RTPS_DllAPI TypeDescriptorget_descriptor ()
 
RTPS_DllAPI bool key_annotation () const
 
RTPS_DllAPI TypeKind get_kind () const
 
RTPS_DllAPI std::string get_name () const
 
RTPS_DllAPI MemberId get_members_count () const
 
RTPS_DllAPI uint32_t get_total_bounds () const
 
RTPS_DllAPI const TypeDescriptorget_type_descriptor () const
 
RTPS_DllAPI bool has_children () const
 
RTPS_DllAPI bool is_consistent () const
 
RTPS_DllAPI bool is_complex_kind () const
 
RTPS_DllAPI bool is_discriminator_type () const
 
RTPS_DllAPI size_t get_size () const
 

Protected Member Functions

 DynamicType ()
 
RTPS_DllAPI DynamicType (const TypeDescriptor *descriptor)
 
 DynamicType (const DynamicTypeBuilder *other)
 
virtual RTPS_DllAPI ~DynamicType ()
 
virtual RTPS_DllAPI void clear ()
 
ReturnCode_t copy_from_builder (const DynamicTypeBuilder *other)
 
bool exists_member_by_name (const std::string &name) const
 
void set_name (const std::string &name)
 
ReturnCode_t apply_annotation (AnnotationDescriptor &descriptor)
 
ReturnCode_t apply_annotation (const std::string &annotation_name, const std::string &key, const std::string &value)
 
ReturnCode_t apply_annotation_to_member (MemberId id, AnnotationDescriptor &descriptor)
 
ReturnCode_t apply_annotation_to_member (MemberId id, const std::string &annotation_name, const std::string &key, const std::string &value)
 
ReturnCode_t get_annotation (AnnotationDescriptor &descriptor, uint32_t idx)
 
uint32_t get_annotation_count ()
 
DynamicType_ptr get_base_type () const
 
DynamicType_ptr get_discriminator_type () const
 
DynamicType_ptr get_element_type () const
 
DynamicType_ptr get_key_element_type () const
 
ReturnCode_t get_member (DynamicTypeMember &member, MemberId id)
 
ReturnCode_t get_member_by_name (DynamicTypeMember &member, const std::string &name)
 

Protected Attributes

TypeDescriptordescriptor_
 
std::map< MemberId, DynamicTypeMember * > member_by_id_
 
std::map< std::string, DynamicTypeMember * > member_by_name_
 
std::string name_
 
TypeKind kind_
 
bool is_key_defined_
 

Friends

class DynamicTypeBuilder
 
class DynamicTypeBuilderFactory
 
class MemberDescriptor
 
class TypeDescriptor
 
class DynamicData
 
class DynamicDataFactory
 
class AnnotationDescriptor
 
class TypeObjectFactory
 
class DynamicTypeMember
 
class DynamicDataHelper
 
class fastdds::dds::DomainParticipantImpl
 

Constructor & Destructor Documentation

◆ DynamicType() [1/3]

DynamicType ( )
protected

◆ DynamicType() [2/3]

RTPS_DllAPI DynamicType ( const TypeDescriptor descriptor)
protected

◆ DynamicType() [3/3]

DynamicType ( const DynamicTypeBuilder other)
protected

◆ ~DynamicType()

virtual RTPS_DllAPI ~DynamicType ( )
protectedvirtual

Member Function Documentation

◆ apply_annotation() [1/2]

ReturnCode_t apply_annotation ( AnnotationDescriptor descriptor)
protected

◆ apply_annotation() [2/2]

ReturnCode_t apply_annotation ( const std::string &  annotation_name,
const std::string &  key,
const std::string &  value 
)
protected

◆ apply_annotation_to_member() [1/2]

ReturnCode_t apply_annotation_to_member ( MemberId  id,
AnnotationDescriptor descriptor 
)
protected

◆ apply_annotation_to_member() [2/2]

ReturnCode_t apply_annotation_to_member ( MemberId  id,
const std::string &  annotation_name,
const std::string &  key,
const std::string &  value 
)
protected

◆ clear()

virtual RTPS_DllAPI void clear ( )
protectedvirtual

◆ copy_from_builder()

ReturnCode_t copy_from_builder ( const DynamicTypeBuilder other)
protected

◆ equals()

RTPS_DllAPI bool equals ( const DynamicType other) const

◆ exists_member_by_name()

bool exists_member_by_name ( const std::string &  name) const
protected

◆ get_all_members()

RTPS_DllAPI ReturnCode_t get_all_members ( std::map< MemberId, DynamicTypeMember * > &  members)

◆ get_all_members_by_name()

RTPS_DllAPI ReturnCode_t get_all_members_by_name ( std::map< std::string, DynamicTypeMember * > &  members)

◆ get_annotation()

ReturnCode_t get_annotation ( AnnotationDescriptor descriptor,
uint32_t  idx 
)
protected

◆ get_annotation_count()

uint32_t get_annotation_count ( )
protected

◆ get_base_type()

DynamicType_ptr get_base_type ( ) const
protected

◆ get_bounds()

RTPS_DllAPI uint32_t get_bounds ( uint32_t  index = 0) const

◆ get_bounds_size()

RTPS_DllAPI uint32_t get_bounds_size ( ) const

◆ get_descriptor() [1/3]

RTPS_DllAPI TypeDescriptor * get_descriptor ( )

◆ get_descriptor() [2/3]

RTPS_DllAPI const TypeDescriptor * get_descriptor ( ) const

◆ get_descriptor() [3/3]

RTPS_DllAPI ReturnCode_t get_descriptor ( TypeDescriptor descriptor) const

◆ get_discriminator_type()

DynamicType_ptr get_discriminator_type ( ) const
protected

◆ get_element_type()

DynamicType_ptr get_element_type ( ) const
protected

◆ get_key_element_type()

DynamicType_ptr get_key_element_type ( ) const
protected

◆ get_kind()

RTPS_DllAPI TypeKind get_kind ( ) const
inline

◆ get_member()

ReturnCode_t get_member ( DynamicTypeMember member,
MemberId  id 
)
protected

◆ get_member_by_name()

ReturnCode_t get_member_by_name ( DynamicTypeMember member,
const std::string &  name 
)
protected

◆ get_members_count()

RTPS_DllAPI MemberId get_members_count ( ) const

◆ get_name()

RTPS_DllAPI std::string get_name ( ) const

◆ get_size()

RTPS_DllAPI size_t get_size ( ) const

◆ get_total_bounds()

RTPS_DllAPI uint32_t get_total_bounds ( ) const

◆ get_type_descriptor()

RTPS_DllAPI const TypeDescriptor * get_type_descriptor ( ) const
inline

◆ has_children()

RTPS_DllAPI bool has_children ( ) const

◆ is_complex_kind()

RTPS_DllAPI bool is_complex_kind ( ) const

◆ is_consistent()

RTPS_DllAPI bool is_consistent ( ) const

◆ is_discriminator_type()

RTPS_DllAPI bool is_discriminator_type ( ) const

◆ key_annotation()

RTPS_DllAPI bool key_annotation ( ) const

◆ set_name()

void set_name ( const std::string &  name)
protected

Friends And Related Symbol Documentation

◆ AnnotationDescriptor

friend class AnnotationDescriptor
friend

◆ DynamicData

friend class DynamicData
friend

◆ DynamicDataFactory

friend class DynamicDataFactory
friend

◆ DynamicDataHelper

friend class DynamicDataHelper
friend

◆ DynamicTypeBuilder

friend class DynamicTypeBuilder
friend

◆ DynamicTypeBuilderFactory

friend class DynamicTypeBuilderFactory
friend

◆ DynamicTypeMember

friend class DynamicTypeMember
friend

◆ fastdds::dds::DomainParticipantImpl

friend class fastdds::dds::DomainParticipantImpl
friend

◆ MemberDescriptor

friend class MemberDescriptor
friend

◆ TypeDescriptor

friend class TypeDescriptor
friend

◆ TypeObjectFactory

friend class TypeObjectFactory
friend

Member Data Documentation

◆ descriptor_

TypeDescriptor* descriptor_
protected

◆ is_key_defined_

bool is_key_defined_
protected

◆ kind_

TypeKind kind_
protected

◆ member_by_id_

std::map<MemberId, DynamicTypeMember*> member_by_id_
protected

◆ member_by_name_

std::map<std::string, DynamicTypeMember*> member_by_name_
protected

◆ name_

std::string name_
protected

The documentation for this class was generated from the following file: