API Documentation

EventMessage

EventMessage::EventMessage ( )

A default constructor.

EventMessage::EventMessage ( … )

A copy constructor.

Parameters
in/out type description
in const EventMessage & Instance being copied.

EventMessage::EventMessage ( … )

This will pair with a node to construct and enable publishing.

Parameters
in/out type description
in Node & Reference to node.

EventMessage::EventMessage ( … )

This will pair with a node to construct and enable publishing and copying a message.

Parameters
in/out type description
in Node & Reference to node.
in ps_msg_ref Message to copy.

EventMessage::EventMessage ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_event_msg & Instance of related type.

EventMessage::~EventMessage ( )

A default destructor.

EventMessage::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

EventMessage::get_ps_event_msg ( ) const

This will provide convenient access to a related type.

Returns

EventMessage::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const EventMessage & Instance to copy.
Returns

static EventMessage::getName ( )

This will get a message name. It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

EventMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

EventMessage::setHeader ( … )

Parameters
in/out type description
in MsgHeader & Message header.
Returns
  • void

EventMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

EventMessage::setHeaderType ( … )

This will set a message type identifier.

Parameters
in/out type description
in ps_msg_type Message type identifier.
Returns
  • void

EventMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

EventMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

Parameters
in/out type description
in ps_timestamp In microseconds.
Returns
  • void

EventMessage::getHeaderSrcGuid ( ) const

This will set a message producer’s GUID.

Returns

EventMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

Parameters
in/out type description
in ps_guid Message producer’s GUID.
Returns
  • void

EventMessage::getDestGuid ( ) const

This will get the message’s destination GUID.

Returns

EventMessage::setDestGuid ( … )

This will set the message’s destination GUID.

Parameters
in/out type description
in ps_guid The destination GUID.
Returns
  • void

EventMessage::getId ( ) const

This will get the event identifier.

Returns

EventMessage::setId ( … )

This will set the event identifier.

Parameters
in/out type description
in ps_event_id The event identifier.
Returns
  • void

EventMessage::getData ( ) const

This will get the event’s data.

Returns

EventMessage::setData ( … )

This will set the event’s data.

Parameters
in/out type description
in datamode::ParameterValue & The event data.
Returns
  • void