openjaus::transport::CompressedHeader Class Reference

This is a brief description. More...

#include <CompressedHeader.h>

Public Member Functions
	CompressedHeader ()
virtual	~CompressedHeader ()
uint8_t	getID () const
	Accessor to get the value of ID. More...
bool	setID (uint8_t ID)
	Accessor to set value of ID. More...
CompressedHeaderStatus	getStatus () const
	Accessor to get the value of status. More...
bool	setStatus (CompressedHeaderStatus status)
	Accessor to set value of status. More...
const system::Buffer &	getData () const
	Accessor to get the value of data. More...
bool	setData (const system::Buffer &data)
	Accessor to set value of data. More...
virtual std::string	toString () const

Protected Attributes
uint8_t	ID
CompressedHeaderStatus	status
system::Buffer	data

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const CompressedHeader &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const CompressedHeader *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

CompressedHeader()

openjaus::transport::CompressedHeader::CompressedHeader

(

)

~CompressedHeader()

openjaus::transport::CompressedHeader::~CompressedHeader ( )

virtual

Member Function Documentation

getData()

const system::Buffer & openjaus::transport::CompressedHeader::getData

(

)

const

getID()

uint8_t openjaus::transport::CompressedHeader::getID

(

)

const

getStatus()

CompressedHeaderStatus openjaus::transport::CompressedHeader::getStatus

(

)

const

setData()

bool openjaus::transport::CompressedHeader::setData

(

const system::Buffer &

data

)

Parameters

data	The value of the new data.

setID()

bool openjaus::transport::CompressedHeader::setID

(

uint8_t

ID

)

Parameters

ID	The value of the new ID.

setStatus()

bool openjaus::transport::CompressedHeader::setStatus

(

CompressedHeaderStatus

status

)

Parameters

status

The value of the new status.

toString()

std::string openjaus::transport::CompressedHeader::toString ( ) const

virtual

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const CompressedHeader &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const CompressedHeader *  object  )

friend

Member Data Documentation

data

system::Buffer openjaus::transport::CompressedHeader::data

protected

ID

uint8_t openjaus::transport::CompressedHeader::ID

protected

status

CompressedHeaderStatus openjaus::transport::CompressedHeader::status

protected

---

The documentation for this class was generated from the following files:

• include/openjaus/transport/CompressedHeader.h
• src/openjaus/transport/CompressedHeader.cpp