API Documentation

CanFrameMessage

CanFrameMessage::CanFrameMessage ( )

A default constructor.

CanFrameMessage::CanFrameMessage ( … )

A copy constructor.

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

CanFrameMessage::CanFrameMessage ( … )

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

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

CanFrameMessage::CanFrameMessage ( … )

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.

CanFrameMessage::CanFrameMessage ( … )

A convenience constructor from a related type.

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

CanFrameMessage::~CanFrameMessage ( )

A default destructor.

CanFrameMessage::print ( … )

This will print internal values.

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

CanFrameMessage::get_ps_can_frame_msg ( ) const

This will provide convenient access to a related type.

Returns

CanFrameMessage::operator= ( … )

An assignment operator.

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

static CanFrameMessage::getName ( )

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

Returns
  • std::string

CanFrameMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

CanFrameMessage::setHeader ( … )

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

CanFrameMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

CanFrameMessage::setHeaderType ( … )

This will set a message type identifier.

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

CanFrameMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

CanFrameMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

CanFrameMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

CanFrameMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

CanFrameMessage::getTimestamp ( ) const

This will get a reception timestamp.

Returns

CanFrameMessage::setTimestamp ( … )

This will set a reception timestamp.

Parameters
in/out type description
in ps_timestamp The set timestamp value.
Returns
  • void

CanFrameMessage::getNativeTimestamp ( ) const

This will get a native timestamp.

Returns

CanFrameMessage::setNativeTimestamp ( … )

This will set a native timestamp.

Parameters
in/out type description
in datamodel::NativeTimestamp The set timestamp value.
Returns
  • void

CanFrameMessage::getNativeTimestampFormat ( ) const

This will get a byte field identifier of a native timestamp format.

Returns
  • unsigned char

CanFrameMessage::setNativeTimestampFormat ( … )

This will set a byte field identifier of a native timestamp format.

Parameters
in/out type description
in unsigned char Native timestamp format.
Returns
  • void

CanFrameMessage::getNativeTimestampValue ( ) const

This will get the value of a native timestamp.

Returns
  • unsigned long long

CanFrameMessage::setNativeTimestampValue ( … )

This will set the value of a native timestamp.

Parameters
in/out type description
in unsigned long long The set value of the native timestamp.
Returns
  • void

CanFrameMessage::getHardwareId ( ) const

This will get the hardware identifier.

Returns

CanFrameMessage::setHardwareId ( … )

This will set the hardware identifier.

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

CanFrameMessage::getCircuitId ( ) const

This will get the circuit identifier.

Returns
  • unsigned long long

CanFrameMessage::setCircuitId ( … )

This will set the circuit identifier.

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

CanFrameMessage::getSystemId ( ) const

This will get the system identifier.

Returns

CanFrameMessage::setSystemId ( … )

This will set the system identifier.

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

CanFrameMessage::getId ( ) const

This will get the CAN frame identifier.

Returns

CanFrameMessage::setId ( … )

This will set the CAN frame identifier.

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

CanFrameMessage::getFlags ( ) const

This will get the CAN frame flags.

Returns
  • unsigned short

CanFrameMessage::set ( … )

This will set the CAN frame flags.

Parameters
in/out type description
in unsigned short The set CAN frame flags.
Returns
  • void

CanFrameMessage::getDataBuffer ( ) const

This will get the CAN frame data buffer.

Returns
  • std::vector< unsigned char >

CanFrameMessage::setDataBuffer ( … )

This will set the CAN frame data buffer.

Parameters
in/out type description
in const std::vector< unsigned char > & The set data buffer.
Returns
  • void