API Documentation

RuntimeNodeStatus

A representation of a PolySync runtime, as seen by the Manager node.

RuntimeNodeStatus::RuntimeNodeStatus ( )

A default constructor.

RuntimeNodeStatus::RuntimeNodeStatus ( … )

A copy constructor.

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

RuntimeNodeStatus::RuntimeNodeStatus ( … )

A convenience constructor from a related type.

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

RuntimeNodeStatus::~RuntimeNodeStatus ( )

A default destructor.

RuntimeNodeStatus::print ( … )

This will print internal values.

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

RuntimeNodeStatus::get_ps_runtime_node_status ( ) const

This will provide convenient access to a related type.

Returns

RuntimeNodeStatus::operator= ( … )

An assignment operator.

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

RuntimeNodeStatus::getProcessId ( ) const

This will get the node’s process identifier.

Returns

RuntimeNodeStatus::setProcessId ( … )

This will set the node’s process identifier.

Parameters
in/out type description
in ps_identifier The process identifier.
Returns
  • void

RuntimeNodeStatus::getDtc ( ) const

This will get the diagnostic trouble code associated with the process status.

Returns

RuntimeNodeStatus::setDtc ( … )

This will set the diagnostic trouble code associated with the process status.

Parameters
in/out type description
in ps_dtc The set diagnostic trouble code.
Returns
  • void

RuntimeNodeStatus::getSdfNodeId ( ) const

This will get the identifier of the node from the system design file.

Returns

RuntimeNodeStatus::setSdfNodeId ( … )

This will set the identifier of the node from the system design file.

Parameters
in/out type description
in ps_identifier The set node identifier.
Returns
  • void

RuntimeNodeStatus::getName ( ) const

This will get the node’s name.

Returns
  • std::string

RuntimeNodeStatus::setName ( … )

This will set the node’s name.

Parameters
in/out type description
in std::string The node name.
Returns
  • void

RuntimeNodeStatus::getReplayMode ( ) const

This will get the flag that indicates if the node is in replay mode.

Returns
  • unsigned char

RuntimeNodeStatus::setReplayMode ( … )

This will set the flag that indicates if the node is in replay mode.

Parameters
in/out type description
in unsigned char The set replay flag value.
Returns
  • void