API Documentation

RnrMessage Class

The Record and Replay Message Class.

RnrMessage::RnrMessage ( )

A default constructor.

RnrMessage::RnrMessage ( … )

A copy constructor.

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

RnrMessage::RnrMessage ( … )

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

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

RnrMessage::RnrMessage ( … )

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

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

RnrMessage::RnrMessage ( … )

A convenience constructor from a related type.

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

RnrMessage::~RnrMessage ( )

A default destructor.

RnrMessage::print ( … )

This will print internal values.

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

RnrMessage::get_ps_rnr_msg ( ) const

This will provide convenient access to a related type.

Returns

RnrMessage::operator= ( … )

An assignment operator.

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

static RnrMessage::getName ( )

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

Returns
  • std::string

RnrMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

RnrMessage::setHeader ( … )

This will set a message header.

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

RnrMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

RnrMessage::setHeaderType ( … )

This will set a message type identifier.

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

RnrMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

RnrMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

RnrMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

RnrMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

RnrMessage::getSessionId ( ) const

This will get the record and replay session identifier.

Returns

RnrMessage::setSessionId ( … )

This will set the record and replay session identifier.

Parameters
in/out type description
in ps_rnr_session_id The set session identifier.
Returns
  • void

RnrMessage::getHostAddress ( ) const

This will get the host address.

Returns

RnrMessage::setHostAddress ( … )

This will set the host address.

Parameters
in/out type description
in ps_interface_address The address value.
Returns
  • void

RnrMessage::getDestGuid ( ) const

This will get the destination node GUID.

Returns

RnrMessage::setDestGuid ( … )

This will set the destination node GUID.

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

RnrMessage::getType ( ) const

This will get the type of the record and replay message.

Returns

RnrMessage::setType ( … )

This will set the type of the record and replay message.

Parameters
in/out type description
in ps_rnr_msg_kind The type of the record and replay message.
Returns
  • void

RnrMessage::getMode ( ) const

This will get the record and replay logfile mode.

Returns

RnrMessage::setMode ( … )

This will set the record and replay logfile mode.

Parameters
in/out type description
in ps_logfile_mode_kind The set mode value.
Returns
  • void

RnrMessage::getState ( ) const

This will get the record and replay logfile state.

Returns

RnrMessage::setState ( … )

This will set the record and replay logfile state.

Parameters
in/out type description
in ps_logfile_state_kind The set state value.
Returns
  • void

RnrMessage::getCurrentTimestamp ( ) const

This will get the current record and replay timestamp.

Returns

RnrMessage::setCurrentTimestamp ( … )

This will set the current record and replay timestamp.

Parameters
in/out type description
in ps_timestamp The set current timestamp.
Returns
  • void

RnrMessage::getBeginTimestamp ( ) const

This will get the beginning record and replay timestamp.

Returns

RnrMessage::setBeginTimestamp ( … )

This will set the beginning record and replay timestamp.

Parameters
in/out type description
in ps_timestamp The set beginning timestamp.
Returns
  • void

RnrMessage::getEndTimestamp ( ) const

This will get the ending record and replay timestamp.

Returns

RnrMessage::setEndTimestamp ( … )

This will set the ending record and replay timestamp.

Parameters
in/out type description
in ps_timestamp The set ending timestamp.
Returns
  • void

RnrMessage::getClockScale ( ) const

This will get the reported clock scale.

Returns
  • double

RnrMessage::setClockScale ( … )

This will set the reported clock scale.

Parameters
in/out type description
in double The set reported clock scale.
Returns
  • void

RnrMessage::getFilePath ( ) const

This will get the absolute path of the logfile.

Returns
  • std::string

RnrMessage::setFilePath ( … )

This will set the absolute path of the logfile.

Parameters
in/out type description
in const std::string & The set absolute file path.
Returns
  • void

RnrMessage::getControlData ( ) const

This will get the control data used by some ps_rnr_msg_kind

Returns
  • datamodel::ParameterValue

RnrMessage::setControlData ( … )

This will set the control data used by some ps_rnr_msg_kind

Parameters
in/out type description
in datamodel::ParameterValue & The set control data.
Returns
  • void