API Documentation

DiagnosticState Class

The diagnostic state of a Node.

DiagnosticState::DiagnosticState ( )

A default constructor.

DiagnosticState::DiagnosticState ( … )

A copy constructor.

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

DiagnosticState::DiagnosticState ( … )

The convenience constructor from a related type.

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

DiagnosticState::~DiagnosticState ( )

A default destructor.

DiagnosticState::print ( … )

This will print internal values.

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

DiagnosticState::get_ps_diagnostic_state ( ) const

This will provide convenient access to a related type.

Returns

DiagnosticState::operator= ( … )

An assignment operator.

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

DiagnosticState::getTimestamp ( ) const

This will get the timestamp of the diagnostic state.

Returns

DiagnosticState::getSrcGuid ( ) const

This will get the GUID of the diagnostic state.

Returns

DiagnosticState::getNodeState ( ) const

This will get the node state from the diagnostic state.

Returns

DiagnosticState::getNodeFlags ( ) const

This will get the node flags from the diagnostic state.

Returns

DiagnosticState::getDtc ( ) const

This will get the diagnostic trouble code from the diagnostic state.

Returns

DiagnosticState::setTimestamp ( … )

This will set the timestamp of the diagnostic state.

Parameters
in/out type description
in ps_timestamp The diagnostic state timestamp.
Returns
  • void

DiagnosticState::setSrcGuid ( … )

This will set the source GUID of the diagnostic state.

Parameters
in/out type description
in ps_guid The diagnostic state source GUID.
Returns
  • void

DiagnosticState::setNodeState ( … )

This will set the node state of the diagnostic state.

Parameters
in/out type description
in ps_node_state_kind The diagnostic state node state.
Returns
  • void

DiagnosticState::setNodeFlags ( … )

This will set the node flags of the diagnostic state.

Parameters
in/out type description
in ps_node_flags The node state value.
Returns
  • void

DiagnosticState::setDtc ( … )

This will set the diagnostic trouble code (DTC) of the diagnostic state.

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