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

Variable message member. More...

#include <MessageVariable.h>

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

Classes

class  Impl
 Message variable implementation. More...
 
class  ImplM
 Message variable implementation (version templated on the message type and the member type) More...
 
class  ImplT
 Message variable implementation (version templated on the message type) More...
 

Public Member Functions

 MessageVariable ()
 Default constructor. More...
 
 MessageVariable (const MessageVariable &src)
 Copy constructor. More...
 
 MessageVariable (const MessageMember &src)
 Copy constructor (overloaded version taking a message member) More...
 
 ~MessageVariable ()
 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

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

Static Protected Member Functions

template<typename T , typename M >
static MessageVariable create (const std::string &name, size_t offset)
 Create a message variable. More...
 

Friends

class MessageDataType
 
class MessageMember
 
class MessageVariant
 

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

Variable message member.

Definition at line 34 of file MessageVariable.h.

Constructor & Destructor Documentation

variant_topic_tools::MessageVariable::MessageVariable ( )

Default constructor.

Definition at line 28 of file MessageVariable.cpp.

variant_topic_tools::MessageVariable::MessageVariable ( const MessageVariable src)

Copy constructor.

Definition at line 36 of file MessageVariable.cpp.

variant_topic_tools::MessageVariable::MessageVariable ( const MessageMember src)

Copy constructor (overloaded version taking a message member)

Definition at line 40 of file MessageVariable.cpp.

variant_topic_tools::MessageVariable::~MessageVariable ( )

Destructor.

Definition at line 46 of file MessageVariable.cpp.

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

Constructor (overloaded version taking a name and a data type)

Definition at line 31 of file MessageVariable.cpp.

Member Function Documentation

template<typename T , typename M >
static MessageVariable variant_topic_tools::MessageVariable::create ( const std::string &  name,
size_t  offset 
)
staticprotected

Create a message variable.

Friends And Related Function Documentation

friend class MessageDataType
friend

Definition at line 36 of file MessageVariable.h.

friend class MessageMember
friend

Definition at line 37 of file MessageVariable.h.

friend class MessageVariant
friend

Definition at line 38 of file MessageVariable.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