API Documentation

ByteArrayMessage

ByteArrayMessage::ByteArrayMessage ( )

A default constructor.

ByteArrayMessage::ByteArrayMessage ( … )

A copy constructor.

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

ByteArrayMessage::ByteArrayMessage ( … )

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

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

ByteArrayMessage::ByteArrayMessage ( … )

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.

ByteArrayMessage::ByteArrayMessage ( … )

A convenience constructor from a related type.

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

ByteArrayMessage::~ByteArrayMessage ( )

A default destructor.

ByteArrayMessage::print ( … )

This will print internal values.

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

ByteArrayMessage::get_ps_byte_array_msg ( ) const

This will provide convenient access to a related type.

Returns

ByteArrayMessage::operator= ( … )

An assignment operator.

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

static ByteArrayMessage::getName ( )

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

Returns
  • std::string

ByteArrayMessage::getHeader ( ) const

This will get a PolySync message header.

Returns

ByteArrayMessage::setHeader ( … )

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

ByteArrayMessage::getHeaderType ( ) const

This will get a message type identifier.

Returns

ByteArrayMessage::setHeaderType ( … )

This will set a message type identifier.

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

ByteArrayMessage::getHeaderTimestamp ( ) const

This will get a message timestamp. [microseconds]

Returns

ByteArrayMessage::setHeaderTimestamp ( … )

This will set a message timestamp. [microseconds]

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

ByteArrayMessage::getHeaderSrcGuid ( ) const

This will get a message producer’s GUID.

Returns

ByteArrayMessage::setHeaderSrcGuid ( … )

This will set a message producer’s GUID.

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

ByteArrayMessage::getDestGuid ( ) const

This will get the destination GUID.

Returns

ByteArrayMessage::setDestGuid ( … )

This will set the destination GUID.

Parameters
in/out type description
in ps_guid The destination GUID.
Returns
  • void

ByteArrayMessage::getDataType ( ) const

This will get the byte array data type.

Returns
  • unsigned long

ByteArrayMessage::set ( … )

This will set the byte array data type.

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

ByteArrayMessage::getBytes ( ) const

This will get the bytes.

Returns
  • std::vector< unsigned char >

ByteArrayMessage::setBytes ( … )

This will set the bytes.

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