OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
openjaus::transport::AS5669::JausWrapper Class Reference

This is a brief description. More...

#include <JausWrapper.h>

Inherits openjaus::transport::Wrapper.

Public Member Functions

 JausWrapper ()
 
virtual ~JausWrapper ()
 
unsigned char getHeaderNumber () const
 Accessor to get the value of headerNumber. More...
 
bool setHeaderNumber (unsigned char headerNumber)
 Accessor to set value of headerNumber. More...
 
unsigned char getHeaderLength () const
 Accessor to get the value of headerLength. More...
 
bool setHeaderLength (unsigned char headerLength)
 Accessor to set value of headerLength. More...
 
unsigned char getHeaderFlags () const
 Accessor to get the value of headerFlags. More...
 
bool setHeaderFlags (unsigned char headerFlags)
 Accessor to set value of headerFlags. More...
 
int to (system::Buffer *dst)
 Operation to. More...
 
int from (system::Buffer *src)
 Operation from. More...
 
virtual int length ()
 Serializes object to internal transport buffer. More...
 
virtual std::string toString () const
 
virtual transport::Wrapperclone ()
 
- Public Member Functions inherited from openjaus::transport::Wrapper
 Wrapper ()
 
virtual ~Wrapper ()
 
AckNakType getAckNak () const
 Accessor to get the value of ackNak. More...
 
bool setAckNak (AckNakType ackNak)
 Accessor to set value of ackNak. More...
 
bool isCompressible () const
 Accessor to get the value of compressible. More...
 
bool setCompressible (bool compressible)
 Accessor to set value of compressible. More...
 
bool isMustArrive () const
 Accessor to get the value of mustArrive. More...
 
bool setMustArrive (bool mustArrive)
 Accessor to set value of mustArrive. More...
 
uint16_t getSequenceNumber () const
 Accessor to get the value of sequenceNumber. More...
 
bool setSequenceNumber (uint16_t sequenceNumber)
 Accessor to set value of sequenceNumber. More...
 
WrapperType getType () const
 Accessor to get the value of type. More...
 
bool setType (WrapperType type)
 Accessor to set value of type. More...
 
Priority getPriority () const
 Accessor to get the value of priority. More...
 
bool setPriority (Priority priority)
 Accessor to set value of priority. More...
 
BroadcastType getBroadcastFlag () const
 Accessor to get the value of broadcastFlag. More...
 
bool setBroadcastFlag (BroadcastType broadcastFlag)
 Accessor to set value of broadcastFlag. More...
 
LargeMessageType getLargeMessageFlag () const
 Accessor to get the value of largeMessageFlag. More...
 
bool setLargeMessageFlag (LargeMessageType largeMessageFlag)
 Accessor to set value of largeMessageFlag. More...
 
const AddressgetDestination () const
 Accessor to get the value of destination. More...
 
bool setDestination (const Address &destination)
 Accessor to set value of destination. More...
 
system::TransportablegetPayload () const
 Accessor to get the value of payload. More...
 
bool setPayload (system::Transportable *payload)
 Accessor to set value of payload. More...
 
const AddressgetSource () const
 Accessor to get the value of source. More...
 
bool setSource (const Address &source)
 Accessor to set value of source. More...
 
TransportDatagetTransportData () const
 Accessor to get the value of transportData. More...
 
bool setTransportData (TransportData *transportData)
 Accessor to set value of transportData. More...
 
virtual int prioritizedValue ()
 Operation prioritizedValue. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 
- Public Member Functions inherited from openjaus::system::Prioritized
virtual ~Prioritized ()
 

Protected Member Functions

 JausWrapper (const JausWrapper &wrapper)
 
- Protected Member Functions inherited from openjaus::transport::Wrapper
 Wrapper (const Wrapper &wrapper)
 

Protected Attributes

unsigned char headerNumber
 
unsigned char headerLength
 
unsigned char headerFlags
 
- Protected Attributes inherited from openjaus::transport::Wrapper
AckNakType ackNak
 
bool compressible
 
bool mustArrive
 
uint16_t sequenceNumber
 
WrapperType type
 
Priority priority
 
BroadcastType broadcastFlag
 
LargeMessageType largeMessageFlag
 
Address destination
 
system::Transportablepayload
 
Address source
 
TransportDatatransportData
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ JausWrapper() [1/2]

openjaus::transport::AS5669::JausWrapper::JausWrapper ( )

§ ~JausWrapper()

openjaus::transport::AS5669::JausWrapper::~JausWrapper ( )
virtual

§ JausWrapper() [2/2]

openjaus::transport::AS5669::JausWrapper::JausWrapper ( const JausWrapper wrapper)
protected

Member Function Documentation

§ clone()

transport::Wrapper * openjaus::transport::AS5669::JausWrapper::clone ( )
virtual

Reimplemented from openjaus::transport::Wrapper.

§ from()

int openjaus::transport::AS5669::JausWrapper::from ( system::Buffer src)
virtual
Parameters
src

Reimplemented from openjaus::transport::Wrapper.

§ getHeaderFlags()

unsigned char openjaus::transport::AS5669::JausWrapper::getHeaderFlags ( ) const

§ getHeaderLength()

unsigned char openjaus::transport::AS5669::JausWrapper::getHeaderLength ( ) const

§ getHeaderNumber()

unsigned char openjaus::transport::AS5669::JausWrapper::getHeaderNumber ( ) const

§ length()

int openjaus::transport::AS5669::JausWrapper::length ( void  )
virtual

Reimplemented from openjaus::transport::Wrapper.

§ setHeaderFlags()

bool openjaus::transport::AS5669::JausWrapper::setHeaderFlags ( unsigned char  headerFlags)
Parameters
headerFlagsThe value of the new headerFlags.

§ setHeaderLength()

bool openjaus::transport::AS5669::JausWrapper::setHeaderLength ( unsigned char  headerLength)
Parameters
headerLengthThe value of the new headerLength.

§ setHeaderNumber()

bool openjaus::transport::AS5669::JausWrapper::setHeaderNumber ( unsigned char  headerNumber)
Parameters
headerNumberThe value of the new headerNumber.

§ to()

int openjaus::transport::AS5669::JausWrapper::to ( system::Buffer dst)
virtual
Parameters
dst

Reimplemented from openjaus::transport::Wrapper.

§ toString()

std::string openjaus::transport::AS5669::JausWrapper::toString ( ) const
virtual

Reimplemented from openjaus::transport::Wrapper.

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ headerFlags

unsigned char openjaus::transport::AS5669::JausWrapper::headerFlags
protected

§ headerLength

unsigned char openjaus::transport::AS5669::JausWrapper::headerLength
protected

§ headerNumber

unsigned char openjaus::transport::AS5669::JausWrapper::headerNumber
protected

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