helics  2.8.1
Public Member Functions | Public Attributes | List of all members
helics::Message Class Reference

#include <core-data.hpp>

Public Member Functions

 Message ()=default
 
void swap (Message &m2) noexcept
 
bool isValid () const noexcept
 
const std::string & to_string () const
 
void clear ()
 

Public Attributes

Time time = timeZero
 the event time the message is sent
 
std::uint16_t flags {0}
 message flags
 
std::uint16_t messageValidation {0U}
 extra field for user object usage, not used by HELICS
 
std::int32_t messageID {0}
 the messageID for a message
 
data_block data
 the data packet for the message
 
std::string dest
 the destination of the message
 
std::string source
 the most recent source of the message
 
std::string original_source
 the original source of the message
 
std::string original_dest
 the original destination of a message
 
std::int32_t counter {0}
 indexing counter not used directly by helics
 
void * backReference {nullptr}
 back referencing pointer not used by helics
 

Detailed Description

class containing a message structure

Constructor & Destructor Documentation

◆ Message()

helics::Message::Message ( )
default

default constructor

Member Function Documentation

◆ clear()

void helics::Message::clear ( )
inline

◆ isValid()

bool helics::Message::isValid ( ) const
inlinenoexcept

check if the Message contains an actual Message

Returns
false if there is no Message data

References data, dest, helics::data_block::empty(), and source.

◆ swap()

void helics::Message::swap ( Message m2)
inlinenoexcept

◆ to_string()

const std::string& helics::Message::to_string ( ) const
inline

get the payload as a string

References data, and helics::data_block::to_string().


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