API Documentation

ResponseMessage

This will be used to respond to a CommandMessage.

ResponseMessage::ResponseMessage ( )

A default constructor.

ResponseMessage::ResponseMessage ( … )

A copy constructor.

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

ResponseMessage::ResponseMessage ( … )

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

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

ResponseMessage::ResponseMessage ( … )

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.

ResponseMessage::ResponseMessage ( … )

A convenience constructor from a related type.

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

ResponseMessage::~ResponseMessage ( )

A default destructor.

ResponseMessage::print ( … )

This will print internal values.

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

ResponseMessage::get_ps_response_msg ( ) const

This will provide convenient access to a related type.

Returns

ResponseMessage::operator= ( … )

An assignment operator.

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

static ResponseMessage::getName ( )

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

Returns
  • std::string

ResponseMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

ResponseMessage::setHeader ( … )

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

ResponseMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

ResponseMessage::setHeaderType ( … )

This will set a message type identifier.

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

ResponseMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

ResponseMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

ResponseMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

ResponseMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

ResponseMessage::getDestinationGuid ( ) const

This will get the destination GUID.

Returns

ResponseMessage::setDestinationGuid ( … )

This will set the destination GUID.

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

ResponseMessage::getId ( ) const

This will get the command type identifier.

Returns

ResponseMessage::setId ( … )

This will set the command type identifier.

Parameters
in/out type description
in ps_command_id The command identifier.
Returns
  • void

ResponseMessage::getTimestamp ( ) const

This will get the time associated with the command.

Returns

ResponseMessage::setTimestamp ( … )

This will set the time associated with the command.

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

ResponseMessage::getDtc ( ) const

This will get the diagnostic trouble code status.

Returns

ResponseMessage::setDtc ( … )

This will set the diagnostic trouble code status.

Parameters
in/out type description
in ps_dtc The DTC value.
Returns
  • void

ResponseMessage::getData ( ) const

This will get the data associated with the command.

Returns
  • std::vector< datamodel::ParameterValue >

ResponseMessage::setData ( … )

This will set the data associated with the command.

Parameters
in/out type description
in const std::vector< datamodel::ParameterValue > & The command data.
Returns
  • void