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

#include <TypeDescriptor.h>

Public Member Functions

RTPS_DllAPI TypeDescriptor ()
 
RTPS_DllAPI TypeDescriptor (const TypeDescriptor *other)
 
RTPS_DllAPI TypeDescriptor (const std::string &name, TypeKind kind)
 
RTPS_DllAPI ~TypeDescriptor ()
 
RTPS_DllAPI ReturnCode_t copy_from (const TypeDescriptor *descriptor)
 
RTPS_DllAPI bool equals (const TypeDescriptor *descriptor) const
 
RTPS_DllAPI bool is_consistent () const
 
RTPS_DllAPI DynamicType_ptr get_base_type () const
 
RTPS_DllAPI uint32_t get_bounds (uint32_t index=0) const
 
RTPS_DllAPI uint32_t get_bounds_size () const
 
RTPS_DllAPI DynamicType_ptr get_discriminator_type () const
 
RTPS_DllAPI DynamicType_ptr get_element_type () const
 
RTPS_DllAPI DynamicType_ptr get_key_element_type () const
 
RTPS_DllAPI TypeKind get_kind () const
 
RTPS_DllAPI std::string get_name () const
 
RTPS_DllAPI uint32_t get_total_bounds () const
 
RTPS_DllAPI void set_kind (TypeKind kind)
 
RTPS_DllAPI void set_name (std::string name)
 
RTPS_DllAPI ReturnCode_t apply_annotation (AnnotationDescriptor &descriptor)
 
RTPS_DllAPI ReturnCode_t apply_annotation (const std::string &annotation_name, const std::string &key, const std::string &value)
 
RTPS_DllAPI AnnotationDescriptorget_annotation (const std::string &name) const
 
RTPS_DllAPI bool annotation_is_extensibility () const
 
RTPS_DllAPI bool annotation_is_mutable () const
 
RTPS_DllAPI bool annotation_is_final () const
 
RTPS_DllAPI bool annotation_is_appendable () const
 
RTPS_DllAPI bool annotation_is_nested () const
 
RTPS_DllAPI bool annotation_is_bit_bound () const
 
RTPS_DllAPI bool annotation_is_key () const
 
RTPS_DllAPI bool annotation_is_non_serialized () const
 
RTPS_DllAPI std::string annotation_get_extensibility () const
 
RTPS_DllAPI bool annotation_get_nested () const
 
RTPS_DllAPI uint16_t annotation_get_bit_bound () const
 
RTPS_DllAPI bool annotation_get_key () const
 
RTPS_DllAPI void annotation_set_extensibility (const std::string &extensibility)
 
RTPS_DllAPI void annotation_set_mutable ()
 
RTPS_DllAPI void annotation_set_final ()
 
RTPS_DllAPI void annotation_set_appendable ()
 
RTPS_DllAPI void annotation_set_nested (bool nested)
 
RTPS_DllAPI void annotation_set_bit_bound (uint16_t bit_bound)
 
RTPS_DllAPI void annotation_set_key (bool key)
 
RTPS_DllAPI void annotation_set_non_serialized (bool non_serialized)
 

Protected Member Functions

RTPS_DllAPI void clean ()
 

Static Protected Member Functions

static bool is_type_name_consistent (const std::string &sName)
 

Protected Attributes

TypeKind kind_
 
std::string name_
 
DynamicType_ptr base_type_
 
DynamicType_ptr discriminator_type_
 
std::vector< uint32_t > bound_
 
DynamicType_ptr element_type_
 
DynamicType_ptr key_element_type_
 
std::vector< AnnotationDescriptor * > annotation_
 

Friends

class DynamicTypeBuilderFactory
 
class TypeObjectFactory
 
class DynamicType
 
class MemberDescriptor
 
class DynamicDataHelper
 

Constructor & Destructor Documentation

◆ TypeDescriptor() [1/3]

RTPS_DllAPI TypeDescriptor ( )

◆ TypeDescriptor() [2/3]

RTPS_DllAPI TypeDescriptor ( const TypeDescriptor other)

◆ TypeDescriptor() [3/3]

RTPS_DllAPI TypeDescriptor ( const std::string &  name,
TypeKind  kind 
)

◆ ~TypeDescriptor()

RTPS_DllAPI ~TypeDescriptor ( )

Member Function Documentation

◆ annotation_get_bit_bound()

RTPS_DllAPI uint16_t annotation_get_bit_bound ( ) const

◆ annotation_get_extensibility()

RTPS_DllAPI std::string annotation_get_extensibility ( ) const

◆ annotation_get_key()

RTPS_DllAPI bool annotation_get_key ( ) const

◆ annotation_get_nested()

RTPS_DllAPI bool annotation_get_nested ( ) const

◆ annotation_is_appendable()

RTPS_DllAPI bool annotation_is_appendable ( ) const

◆ annotation_is_bit_bound()

RTPS_DllAPI bool annotation_is_bit_bound ( ) const

◆ annotation_is_extensibility()

RTPS_DllAPI bool annotation_is_extensibility ( ) const

◆ annotation_is_final()

RTPS_DllAPI bool annotation_is_final ( ) const

◆ annotation_is_key()

RTPS_DllAPI bool annotation_is_key ( ) const

◆ annotation_is_mutable()

RTPS_DllAPI bool annotation_is_mutable ( ) const

◆ annotation_is_nested()

RTPS_DllAPI bool annotation_is_nested ( ) const

◆ annotation_is_non_serialized()

RTPS_DllAPI bool annotation_is_non_serialized ( ) const

◆ annotation_set_appendable()

RTPS_DllAPI void annotation_set_appendable ( )

◆ annotation_set_bit_bound()

RTPS_DllAPI void annotation_set_bit_bound ( uint16_t  bit_bound)

◆ annotation_set_extensibility()

RTPS_DllAPI void annotation_set_extensibility ( const std::string &  extensibility)

◆ annotation_set_final()

RTPS_DllAPI void annotation_set_final ( )

◆ annotation_set_key()

RTPS_DllAPI void annotation_set_key ( bool  key)

◆ annotation_set_mutable()

RTPS_DllAPI void annotation_set_mutable ( )

◆ annotation_set_nested()

RTPS_DllAPI void annotation_set_nested ( bool  nested)

◆ annotation_set_non_serialized()

RTPS_DllAPI void annotation_set_non_serialized ( bool  non_serialized)

◆ apply_annotation() [1/2]

RTPS_DllAPI ReturnCode_t apply_annotation ( AnnotationDescriptor descriptor)

◆ apply_annotation() [2/2]

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

◆ clean()

RTPS_DllAPI void clean ( )
protected

◆ copy_from()

RTPS_DllAPI ReturnCode_t copy_from ( const TypeDescriptor descriptor)

◆ equals()

RTPS_DllAPI bool equals ( const TypeDescriptor descriptor) const

◆ get_annotation()

RTPS_DllAPI AnnotationDescriptor * get_annotation ( const std::string &  name) const

◆ get_base_type()

RTPS_DllAPI DynamicType_ptr get_base_type ( ) const

◆ 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_discriminator_type()

RTPS_DllAPI DynamicType_ptr get_discriminator_type ( ) const

◆ get_element_type()

RTPS_DllAPI DynamicType_ptr get_element_type ( ) const

◆ get_key_element_type()

RTPS_DllAPI DynamicType_ptr get_key_element_type ( ) const

◆ get_kind()

RTPS_DllAPI TypeKind get_kind ( ) const

◆ get_name()

RTPS_DllAPI std::string get_name ( ) const

◆ get_total_bounds()

RTPS_DllAPI uint32_t get_total_bounds ( ) const

◆ is_consistent()

RTPS_DllAPI bool is_consistent ( ) const

◆ is_type_name_consistent()

static bool is_type_name_consistent ( const std::string &  sName)
staticprotected

◆ set_kind()

RTPS_DllAPI void set_kind ( TypeKind  kind)

◆ set_name()

RTPS_DllAPI void set_name ( std::string  name)

Friends And Related Symbol Documentation

◆ DynamicDataHelper

friend class DynamicDataHelper
friend

◆ DynamicType

friend class DynamicType
friend

◆ DynamicTypeBuilderFactory

friend class DynamicTypeBuilderFactory
friend

◆ MemberDescriptor

friend class MemberDescriptor
friend

◆ TypeObjectFactory

friend class TypeObjectFactory
friend

Member Data Documentation

◆ annotation_

std::vector<AnnotationDescriptor*> annotation_
protected

◆ base_type_

DynamicType_ptr base_type_
protected

◆ bound_

std::vector<uint32_t> bound_
protected

◆ discriminator_type_

DynamicType_ptr discriminator_type_
protected

◆ element_type_

DynamicType_ptr element_type_
protected

◆ key_element_type_

DynamicType_ptr key_element_type_
protected

◆ kind_

TypeKind kind_
protected

◆ name_

std::string name_
protected

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