API Documentation

ParametersMessage Class

The Parameter Message Class.

ParametersMessage::ParametersMessage ( )

A default constructor.

ParametersMessage::ParametersMessage ( … )

A copy constructor.

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

ParametersMessage::ParametersMessage ( … )

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

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

ParametersMessage::ParametersMessage ( … )

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.

ParametersMessage::ParametersMessage ( … )

A convenience constructor from a related type.

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

ParametersMessage::~ParametersMessage ( )

A default destructor.

ParametersMessage::print ( … )

This will print internal values.

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

ParametersMessage::get_ps_parameters_msg ( ) const

This will provide convenient access to a related type.

Returns

ParametersMessage::operator= ( … )

An assignment operator.

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

static ParametersMessage::getName ( )

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

Returns
  • std::string

ParametersMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

ParametersMessage::setHeader ( … )

This will set the message header.

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

ParametersMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

ParametersMessage::setHeaderType ( … )

This will set the message type identifier.

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

ParametersMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

ParametersMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

ParametersMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

ParametersMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

ParametersMessage::getDestGuid ( ) const

This will get the message’s destination GUID.

Returns

ParametersMessage::setDestGuid ( … )

This will set the message’s destination GUID.

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

ParametersMessage::getType ( ) const

This will get the type of parameter message.

Returns

ParametersMessage::setType ( … )

This will set the type of parameter message.

Parameters
in/out type description
in ps_parameter_message_kind The type of the parameters message.
Returns
  • void

ParametersMessage::getParameters ( ) const

This will get all of the parameters contained in the message.

Returns

ParametersMessage::setParameters ( … )

This will set all of the parameters contained in the message.

Parameters
in/out type description
in const std::vector< datamodel::Parameter > & The parameters to copy to the message.
Returns
  • void