API Documentation

SdfStateMessage

The System Design File State Message Class.

SdfStateMessage::SdfStateMessage ( )

A default constructor.

SdfStateMessage::SdfStateMessage ( … )

A copy constructor.

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

SdfStateMessage::SdfStateMessage ( … )

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

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

SdfStateMessage::SdfStateMessage ( … )

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.

SdfStateMessage::SdfStateMessage ( … )

A convenience constructor from a related type.

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

SdfStateMessage::~SdfStateMessage ( )

A default destructor.

SdfStateMessage::print ( … )

This will print internal values.

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

SdfStateMessage::get_ps_sdf_state_msg ( ) const

This will provide convenient access to a related type.

Returns

SdfStateMessage::operator= ( … )

An assignment operator.

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

static SdfStateMessage::getName ( )

This will get the message name

It is useful in functions requiring message names, such as getMessageTypeByName.

Returns
  • std::string

SdfStateMessage::getHeader ( ) const

This will get the PolySync message header.

Returns

SdfStateMessage::setHeader ( … )

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

SdfStateMessage::getHeaderType ( ) const

This will get the message type identifier.

Returns

SdfStateMessage::setHeaderType ( … )

This will set the message type identifier.

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

SdfStateMessage::getHeaderTimestamp ( ) const

This will get the message timestamp. [microseconds]

Returns

SdfStateMessage::setHeaderTimestamp ( … )

This will set the message timestamp. [microseconds]

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

SdfStateMessage::getHeaderSrcGuid ( ) const

This will get the message producer’s GUID.

Returns

SdfStateMessage::setHeaderSrcGuid ( … )

This will set the message producer’s GUID.

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

SdfStateMessage::getRuntimeConfiguration ( ) const

This will get the runtime configuration.

Returns

SdfStateMessage::setRuntimeConfiguration ( … )

This will set the runtime configuration.

Parameters
in/out type description
in datamodel::SdfRuntimeConfiguration & The set configuration.
Returns
  • void

SdfStateMessage::getRuntimeConfigurationId ( ) const

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

Returns
  • unsigned long

SdfStateMessage::setRuntimeConfigurationId ( … )

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

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

SdfStateMessage::getRuntimeConfigurationParameterListId ( ) const

This will get the parameter list identifier of the runtime configuration in the system design file.

Returns
  • unsigned long

SdfStateMessage::setRuntimeConfigurationParameterListId ( … )

This will set the parameter list identifier of the runtime configuration in the system design file.

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

SdfStateMessage::getRuntimeConfigurationName ( ) const

This will get the name.

Returns
  • std::string

SdfStateMessage::setRuntimeConfigurationName ( … )

This will set the name.

Parameters
in/out type description
in const std::string & The set configuration name.
Returns
  • void

SdfStateMessage::getRuntimeConfigurationDomainId ( ) const

This will get the identifier of the domain the runtime is using.

Returns
  • unsigned long

SdfStateMessage::setRuntimeConfigurationDomainId ( … )

This will set the identifier of the domain the runtime is using.

Parameters
in/out type description
in unsigned long The domain identifier.
Returns
  • void

SdfStateMessage::getRuntimeConfigurationApiVersion ( ) const

This will get the runtime configuration’s API version.

Returns
  • std::string

SdfStateMessage::setRuntimeConfigurationApiVersion ( … )

This will set the runtime configuration’s API version.

Parameters
in/out type description
in std::string The runtime’s API version string.
Returns
  • void

SdfStateMessage::getRuntimeConfigurationHostConfigs ( ) const

This will get the host configurations.

Returns

SdfStateMessage::setRuntimeConfigurationHostConfigs ( … )

This will set the host configurations.

Parameters
in/out type description
in const std::vector< datamodel::SdfHostConfiguration > & The host configurations to copy.
Returns
  • void

SdfStateMessage::getRuntimeConfigurationParameterValues ( ) const

This will get the runtime’s parameter values.

Returns

SdfStateMessage::setRuntimeConfigurationParameterValues ( … )

This will set the runtime’s parameter values.

Parameters
in/out type description
in const std::vector< datamodel::SdfParameterValue > & The parameter values to copy.
Returns
  • void