API Documentation

MsgHeader Class

The Message Header Class.

MsgHeader::MsgHeader ( )

A default constructor.

MsgHeader::MsgHeader ( … )

A copy constructor.

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

MsgHeader::MsgHeader ( … )

A convenience constructor from a related type.

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

MsgHeader::~MsgHeader ( )

A default destructor.

MsgHeader::print ( … )

This will print internal values.

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

MsgHeader::get_ps_msg_header ( ) const

This will provide convenient access to a related type.

Returns

MsgHeader::operator= ( … )

An assignment operator.

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

MsgHeader::getType ( ) const

This will get a message type from the message header.

Returns

MsgHeader::getTimestamp ( ) const

This will get a timestamp from the message header.

Returns

MsgHeader::getSrcGuid ( ) const

This will get the GUID of the message source.

Returns

MsgHeader::setType ( … )

This will set the message type in the message header.

Parameters
in/out type description
in ps_msg_type Message type value.

MsgHeader::setTimestamp ( … )

This will set the timestamp in the message header.

Parameters
in/out type description
in ps_timestamp Message timestamp value.

MsgHeader::setSrcGuid ( … )

This will set the source GUID in the message header.

Parameters
in/out type description
in ps_guid Message source GUID.