API Documentation

ManagerStatusMessage

ManagerStatusMessage::ManagerStatusMessage ( )

A default constructor.

ManagerStatusMessage::ManagerStatusMessage ( … )

A copy constructor.

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

ManagerStatusMessage::ManagerStatusMessage ( … )

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

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

ManagerStatusMessage::ManagerStatusMessage ( … )

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.

ManagerStatusMessage::ManagerStatusMessage ( … )

A convenience constructor from a related type.

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

ManagerStatusMessage::~ManagerStatusMessage ( )

A default destructor.

ManagerStatusMessage::print ( … )

This will print internal values.

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

ManagerStatusMessage::get_ps_manager_status_msg ( ) const

This will provide convenient access to a related type.

Returns

ManagerStatusMessage::operator= ( … )

An assignment operator.

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

static ManagerStatusMessage::getName ( )

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

Returns
  • std::string

ManagerStatusMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

ManagerStatusMessage::setHeader ( … )

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

ManagerStatusMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

ManagerStatusMessage::setHeaderType ( … )

This will set a message type identifier.

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

ManagerStatusMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

ManagerStatusMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

ManagerStatusMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

ManagerStatusMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

ManagerStatusMessage::getHostAddress ( ) const

This will get the host address.

Returns

ManagerStatusMessage::setHostAddress ( … )

This will set the host address.

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

ManagerStatusMessage::getSdfRuntimeId ( ) const

This will get the identifier of the system design file runtime.

Returns
  • unsigned long

ManagerStatusMessage::setSdfRuntimeId ( … )

This will set the identifier of the system design file runtime.

Parameters
in/out type description
in unsigned long The runtime’s system design file identifier.
Returns
  • void

ManagerStatusMessage::getRuntimeNodes ( ) const

This will get the nodes in the active runtime.

Returns

ManagerStatusMessage::setRuntimeNodes ( … )

This will set the nodes in the active runtime.

Parameters
in/out type description
in const std::vector< datamodel::RuntimeNodeStatus > & The runtime node statuses to copy.
Returns
  • void