API Documentation

DiagnosticTraceMessage

DiagnosticTraceMessage::DiagnosticTraceMessage ( )

A default constructor.

DiagnosticTraceMessage::DiagnosticTraceMessage ( … )

A copy constructor.

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

DiagnosticTraceMessage::DiagnosticTraceMessage ( … )

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

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

DiagnosticTraceMessage::DiagnosticTraceMessage ( … )

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

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

DiagnosticTraceMessage::DiagnosticTraceMessage ( … )

A convenience constructor from a related type.

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

DiagnosticTraceMessage::~DiagnosticTraceMessage ( )

A default destructor.

DiagnosticTraceMessage::print ( … )

This will print internal values.

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

DiagnosticTraceMessage::get_ps_diagnostic_trace_msg ( ) const

This will provide convenient access to a related type.

Returns

DiagnosticTraceMessage::operator= ( … )

An assignment operator.

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

static DiagnosticTraceMessage::getName ( )

This will get a message name.

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

Returns
  • std::string

DiagnosticTraceMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

DiagnosticTraceMessage::setHeader ( … )

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

DiagnosticTraceMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

DiagnosticTraceMessage::setHeaderType ( … )

This will set a message type identifier.

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

DiagnosticTraceMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

DiagnosticTraceMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

DiagnosticTraceMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

DiagnosticTraceMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

DiagnosticTraceMessage::getHostAddress ( ) const

This will get a host address.

Returns

DiagnosticTraceMessage::setHostAddress ( … )

This will set the host address.

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

DiagnosticTraceMessage::getApiVersion ( ) const

This will get the API version.

Returns

DiagnosticTraceMessage::setApiVersion ( … )

This will set the API version.

Parameters
in/out type description
in datamodel::version & The API version.
Returns
  • void

DiagnosticTraceMessage::getCoreVersion ( ) const

This will get the datamodel core version.

Returns

DiagnosticTraceMessage::set ( … )

This will set the datamodel core version.

Parameters
in/out type description
in datamodel::version & The datamodel core version.
Returns
  • void

DiagnosticTraceMessage::getTrace ( ) const

This will get the diagnostic trace buffer.

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

DiagnosticTraceMessage::set ( … )

This will set the diagnostic trace buffer.

Parameters
in/out type description
in std::vector< datamodel::DiagnosticState > The set trace buffer.
Returns
  • void