iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::AnyMessage Class Reference

#include <nrt/Core/Blackboard/AnyMessage.H>

Generic opaque message that can contain any message data.

nrt::AnyMessage cannot be directly constructed by users. Rather, it can be received (via a MessageSubscriber port), possibly queued, etc and then re-posted (via a MessagePoster port). nrt::AnyMessage is useful to construct very general modules which do not need to know or look into the actual contents of a message. This includes queues, stacks, temporal sub-samplers or over-samplers, synchronizers, barriers, sequencers, dispatchers, etc.

See Messages, Blackboard and Modules for general conceptual motivation for AnyMessage.

See FifoQueueModule and other Generic modules in nrtbase for examples.

Definition at line 57 of file AnyMessage.H.

Inheritance diagram for nrt::AnyMessage:
nrt::MessageBase nrt::MessageTypesCreator< AnyMessage >

Public Member Functions

 ~AnyMessage ()
 Virtual destructor.
 
std::string const & typeStr () const
 Return the underlying native message type as a string. More...
 
- Public Member Functions inherited from nrt::MessageBase
 MessageBase ()
 Constructor.
 
virtual ~MessageBase ()
 Virtual destructor for safe inheritance.
 
virtual std::string description () const
 A short description of the Message type. More...
 

Friends

class Blackboard
 
template<class Posting >
class MessagePosterCore
 
template<class Subscription >
class MessageSubscriberCore
 
template<class Checking >
class MessageCheckerCore
 
class cereal::access
 

Additional Inherited Members

- Public Types inherited from nrt::MessageTypesCreator< AnyMessage >
typedef std::shared_ptr
< AnyMessageconst > 
const_ptr
 A shared constant pointer to this message type (messages are always received as this type)
 
typedef std::unique_ptr
< AnyMessage
unique_ptr
 A shared unique pointer to this message type (messages are always sent and returned as this type)
 
- Static Public Attributes inherited from nrt::MessageBase
static bool const isComposite = false
 Is this message composite and can it be split into parts? More...
 

Member Function Documentation

std::string const & nrt::AnyMessage::typeStr ( ) const
inline

Return the underlying native message type as a string.

Should only be used for debugging/info messages as the underlying string representation may change with versions of the C++ compiler used or with other factors.

Definition at line 89 of file AnyMessageImpl.H.


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