Fast RTPS  Version 2.11.2
Fast RTPS
Loading...
Searching...
No Matches
MemberDescriptor Class Reference

#include <MemberDescriptor.h>

Public Member Functions

RTPS_DllAPI MemberDescriptor ()
 
RTPS_DllAPI MemberDescriptor (uint32_t index, const std::string &name)
 
RTPS_DllAPI MemberDescriptor (MemberId id, const std::string &name, DynamicType_ptr type_)
 
RTPS_DllAPI MemberDescriptor (MemberId id, const std::string &name, DynamicType_ptr type_, const std::string &defaultValue)
 
RTPS_DllAPI MemberDescriptor (MemberId id, const std::string &name, DynamicType_ptr type_, const std::string &defaultValue, const std::vector< uint64_t > &unionLabels, bool isDefaultLabel)
 
RTPS_DllAPI MemberDescriptor (const MemberDescriptor *descriptor)
 
RTPS_DllAPI ~MemberDescriptor ()
 
bool check_union_labels (const std::vector< uint64_t > &labels) const
 
RTPS_DllAPI ReturnCode_t copy_from (const MemberDescriptor *other)
 
RTPS_DllAPI bool equals (const MemberDescriptor *other) const
 
RTPS_DllAPI TypeKind get_kind () const
 
RTPS_DllAPI MemberId get_id () const
 
RTPS_DllAPI uint32_t get_index () const
 
RTPS_DllAPI std::string get_name () const
 
RTPS_DllAPI std::vector< uint64_t > get_union_labels () const
 
RTPS_DllAPI std::string get_default_value () const
 
RTPS_DllAPI bool is_default_union_value () const
 
RTPS_DllAPI bool is_consistent (TypeKind parentKind) const
 
RTPS_DllAPI void add_union_case_index (uint64_t value)
 
RTPS_DllAPI void set_id (MemberId id)
 
RTPS_DllAPI void set_index (uint32_t index)
 
RTPS_DllAPI void set_name (const std::string &name)
 
RTPS_DllAPI void set_type (DynamicType_ptr type)
 
RTPS_DllAPI DynamicType_ptr get_type () const
 
RTPS_DllAPI void set_default_union_value (bool bDefault)
 
RTPS_DllAPI void set_default_value (const std::string &value)
 
ReturnCode_t apply_annotation (AnnotationDescriptor &descriptor)
 
ReturnCode_t apply_annotation (const std::string &annotation_name, const std::string &key, const std::string &value)
 
AnnotationDescriptorget_annotation (const std::string &name) const
 
RTPS_DllAPI bool annotation_is_optional () const
 
RTPS_DllAPI bool annotation_is_key () const
 
RTPS_DllAPI bool annotation_is_must_understand () const
 
RTPS_DllAPI bool annotation_is_non_serialized () const
 
RTPS_DllAPI bool annotation_is_value () const
 
RTPS_DllAPI bool annotation_is_default_literal () const
 
RTPS_DllAPI bool annotation_is_position () const
 
RTPS_DllAPI bool annotation_is_bit_bound () const
 
RTPS_DllAPI bool annotation_get_key () const
 
RTPS_DllAPI std::string annotation_get_value () const
 
RTPS_DllAPI std::string annotation_get_default () const
 
RTPS_DllAPI uint16_t annotation_get_position () const
 
RTPS_DllAPI uint16_t annotation_get_bit_bound () const
 
RTPS_DllAPI void annotation_set_optional (bool optional)
 
RTPS_DllAPI void annotation_set_key (bool key)
 
RTPS_DllAPI void annotation_set_must_understand (bool must_understand)
 
RTPS_DllAPI void annotation_set_non_serialized (bool non_serialized)
 
RTPS_DllAPI void annotation_set_value (const std::string &value)
 
RTPS_DllAPI void annotation_set_default (const std::string &default_value)
 
RTPS_DllAPI void annotation_set_default_literal ()
 
RTPS_DllAPI void annotation_set_position (uint16_t position)
 
RTPS_DllAPI void annotation_set_bit_bound (uint16_t bit_bound)
 

Protected Member Functions

bool is_default_value_consistent (const std::string &sDefaultValue) const
 
bool is_type_name_consistent (const std::string &sName) const
 

Protected Attributes

std::string name_
 
MemberId id_
 
DynamicType_ptr type_
 
std::string default_value_
 
uint32_t index_
 
std::vector< uint64_t > labels_
 
bool default_label_
 
std::vector< AnnotationDescriptor * > annotation_
 

Friends

class DynamicTypeBuilderFactory
 
class DynamicData
 
class DynamicTypeMember
 
class TypeObjectFactory
 

Constructor & Destructor Documentation

◆ MemberDescriptor() [1/6]

RTPS_DllAPI MemberDescriptor ( )

◆ MemberDescriptor() [2/6]

RTPS_DllAPI MemberDescriptor ( uint32_t index,
const std::string & name )

◆ MemberDescriptor() [3/6]

RTPS_DllAPI MemberDescriptor ( MemberId id,
const std::string & name,
DynamicType_ptr type_ )

◆ MemberDescriptor() [4/6]

RTPS_DllAPI MemberDescriptor ( MemberId id,
const std::string & name,
DynamicType_ptr type_,
const std::string & defaultValue )

◆ MemberDescriptor() [5/6]

RTPS_DllAPI MemberDescriptor ( MemberId id,
const std::string & name,
DynamicType_ptr type_,
const std::string & defaultValue,
const std::vector< uint64_t > & unionLabels,
bool isDefaultLabel )

◆ MemberDescriptor() [6/6]

RTPS_DllAPI MemberDescriptor ( const MemberDescriptor * descriptor)

◆ ~MemberDescriptor()

RTPS_DllAPI ~MemberDescriptor ( )

Member Function Documentation

◆ add_union_case_index()

RTPS_DllAPI void add_union_case_index ( uint64_t value)

◆ annotation_get_bit_bound()

RTPS_DllAPI uint16_t annotation_get_bit_bound ( ) const

◆ annotation_get_default()

RTPS_DllAPI std::string annotation_get_default ( ) const

◆ annotation_get_key()

RTPS_DllAPI bool annotation_get_key ( ) const

◆ annotation_get_position()

RTPS_DllAPI uint16_t annotation_get_position ( ) const

◆ annotation_get_value()

RTPS_DllAPI std::string annotation_get_value ( ) const

◆ annotation_is_bit_bound()

RTPS_DllAPI bool annotation_is_bit_bound ( ) const

◆ annotation_is_default_literal()

RTPS_DllAPI bool annotation_is_default_literal ( ) const

◆ annotation_is_key()

RTPS_DllAPI bool annotation_is_key ( ) const

◆ annotation_is_must_understand()

RTPS_DllAPI bool annotation_is_must_understand ( ) const

◆ annotation_is_non_serialized()

RTPS_DllAPI bool annotation_is_non_serialized ( ) const

◆ annotation_is_optional()

RTPS_DllAPI bool annotation_is_optional ( ) const

◆ annotation_is_position()

RTPS_DllAPI bool annotation_is_position ( ) const

◆ annotation_is_value()

RTPS_DllAPI bool annotation_is_value ( ) const

◆ annotation_set_bit_bound()

RTPS_DllAPI void annotation_set_bit_bound ( uint16_t bit_bound)

◆ annotation_set_default()

RTPS_DllAPI void annotation_set_default ( const std::string & default_value)

◆ annotation_set_default_literal()

RTPS_DllAPI void annotation_set_default_literal ( )

◆ annotation_set_key()

RTPS_DllAPI void annotation_set_key ( bool key)

◆ annotation_set_must_understand()

RTPS_DllAPI void annotation_set_must_understand ( bool must_understand)

◆ annotation_set_non_serialized()

RTPS_DllAPI void annotation_set_non_serialized ( bool non_serialized)

◆ annotation_set_optional()

RTPS_DllAPI void annotation_set_optional ( bool optional)

◆ annotation_set_position()

RTPS_DllAPI void annotation_set_position ( uint16_t position)

◆ annotation_set_value()

RTPS_DllAPI void annotation_set_value ( const std::string & value)

◆ apply_annotation() [1/2]

ReturnCode_t apply_annotation ( AnnotationDescriptor & descriptor)

◆ apply_annotation() [2/2]

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

◆ check_union_labels()

bool check_union_labels ( const std::vector< uint64_t > & labels) const

◆ copy_from()

RTPS_DllAPI ReturnCode_t copy_from ( const MemberDescriptor * other)

◆ equals()

RTPS_DllAPI bool equals ( const MemberDescriptor * other) const

◆ get_annotation()

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

◆ get_default_value()

RTPS_DllAPI std::string get_default_value ( ) const
inline

◆ get_id()

RTPS_DllAPI MemberId get_id ( ) const

◆ get_index()

RTPS_DllAPI uint32_t get_index ( ) const

◆ get_kind()

RTPS_DllAPI TypeKind get_kind ( ) const

◆ get_name()

RTPS_DllAPI std::string get_name ( ) const

◆ get_type()

RTPS_DllAPI DynamicType_ptr get_type ( ) const
inline

◆ get_union_labels()

RTPS_DllAPI std::vector< uint64_t > get_union_labels ( ) const

◆ is_consistent()

RTPS_DllAPI bool is_consistent ( TypeKind parentKind) const

◆ is_default_union_value()

RTPS_DllAPI bool is_default_union_value ( ) const

◆ is_default_value_consistent()

bool is_default_value_consistent ( const std::string & sDefaultValue) const
protected

◆ is_type_name_consistent()

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

◆ set_default_union_value()

RTPS_DllAPI void set_default_union_value ( bool bDefault)

◆ set_default_value()

RTPS_DllAPI void set_default_value ( const std::string & value)
inline

◆ set_id()

RTPS_DllAPI void set_id ( MemberId id)

◆ set_index()

RTPS_DllAPI void set_index ( uint32_t index)

◆ set_name()

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

◆ set_type()

RTPS_DllAPI void set_type ( DynamicType_ptr type)

Friends And Related Symbol Documentation

◆ DynamicData

friend class DynamicData
friend

◆ DynamicTypeBuilderFactory

friend class DynamicTypeBuilderFactory
friend

◆ DynamicTypeMember

friend class DynamicTypeMember
friend

◆ TypeObjectFactory

friend class TypeObjectFactory
friend

Member Data Documentation

◆ annotation_

std::vector<AnnotationDescriptor*> annotation_
protected

◆ default_label_

bool default_label_
protected

◆ default_value_

std::string default_value_
protected

◆ id_

MemberId id_
protected

◆ index_

uint32_t index_
protected

◆ labels_

std::vector<uint64_t> labels_
protected

◆ name_

std::string name_
protected

◆ type_

DynamicType_ptr type_
protected

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