Classes | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
variant_topic_tools::MessageConstant Class Reference

Constant message member. More...

#include <MessageConstant.h>

Inheritance diagram for variant_topic_tools::MessageConstant:
Inheritance graph
[legend]

Classes

class  Impl
 Message constant implementation. More...
 

Public Member Functions

const VariantgetValue () const
 Retrieve the value of this message constant. More...
 
 MessageConstant ()
 Default constructor. More...
 
 MessageConstant (const MessageConstant &src)
 Copy constructor. More...
 
 MessageConstant (const MessageMember &src)
 Copy constructor (overloaded version taking a message member) More...
 
 ~MessageConstant ()
 Destructor. More...
 
- Public Member Functions inherited from variant_topic_tools::MessageMember
const std::string & getName () const
 Retrieve the name of this message member. More...
 
const DataTypegetType () const
 Retrieve the type of this message member. More...
 
bool isConstant () const
 True, if this message member is a constant member. More...
 
bool isValid () const
 True, if this message member is valid. More...
 
bool isVariable () const
 True, if this message member is a variable member. More...
 
 MessageMember ()
 Default constructor. More...
 
 MessageMember (const MessageMember &src)
 Copy constructor. More...
 
 operator void * () const
 Void pointer conversion. More...
 
void write (std::ostream &stream) const
 Write the message member to a stream. More...
 
 ~MessageMember ()
 Destructor. More...
 

Protected Member Functions

 MessageConstant (const std::string &name, const Variant &value)
 Constructor (overloaded version taking a name and a variant value) More...
 
 MessageConstant (const std::string &name, const DataType &type, const std::string &value)
 Constructor (overloaded version taking a name, a data type, and a string value) More...
 

Static Protected Member Functions

template<typename T >
static MessageConstant create (const std::string &name, const T &value)
 Create a message constant. More...
 

Friends

class MessageDataType
 
class MessageMember
 

Additional Inherited Members

- Protected Types inherited from variant_topic_tools::MessageMember
typedef boost::shared_ptr< ImplImplPtr
 Declaration of the message member implementation pointer type. More...
 
typedef boost::weak_ptr< ImplImplWPtr
 Declaration of the message member implementation weak pointer type. More...
 
- Protected Attributes inherited from variant_topic_tools::MessageMember
ImplPtr impl
 The message member's implementation. More...
 

Detailed Description

Constant message member.

Definition at line 32 of file MessageConstant.h.

Constructor & Destructor Documentation

variant_topic_tools::MessageConstant::MessageConstant ( )

Default constructor.

Definition at line 30 of file MessageConstant.cpp.

variant_topic_tools::MessageConstant::MessageConstant ( const MessageConstant src)

Copy constructor.

Definition at line 54 of file MessageConstant.cpp.

variant_topic_tools::MessageConstant::MessageConstant ( const MessageMember src)

Copy constructor (overloaded version taking a message member)

Definition at line 58 of file MessageConstant.cpp.

variant_topic_tools::MessageConstant::~MessageConstant ( )

Destructor.

Definition at line 64 of file MessageConstant.cpp.

variant_topic_tools::MessageConstant::MessageConstant ( const std::string &  name,
const Variant value 
)
protected

Constructor (overloaded version taking a name and a variant value)

Definition at line 33 of file MessageConstant.cpp.

variant_topic_tools::MessageConstant::MessageConstant ( const std::string &  name,
const DataType type,
const std::string &  value 
)
protected

Constructor (overloaded version taking a name, a data type, and a string value)

Definition at line 38 of file MessageConstant.cpp.

Member Function Documentation

template<typename T >
static MessageConstant variant_topic_tools::MessageConstant::create ( const std::string &  name,
const T &  value 
)
staticprotected

Create a message constant.

const Variant & variant_topic_tools::MessageConstant::getValue ( ) const

Retrieve the value of this message constant.

Definition at line 81 of file MessageConstant.cpp.

Friends And Related Function Documentation

friend class MessageDataType
friend

Definition at line 34 of file MessageConstant.h.

friend class MessageMember
friend

Definition at line 35 of file MessageConstant.h.


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


variant_topic_tools
Author(s): Ralf Kaestner
autogenerated on Sat Jan 9 2021 03:56:50