OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
openjaus::hmi::ReportAnalogAction Class Reference

ReportAnalogAction Message Implementation. More...

#include <ReportAnalogAction.h>

Inherits openjaus::model::Message.

Public Member Functions

 ReportAnalogAction ()
 ReportAnalogAction (model::Message *message)
 ~ReportAnalogAction ()
virtual int to (system::Buffer *dst)
 Pack this message to the given openjaus::system::Buffer. More...
virtual int from (system::Buffer *src)
 Unpack this message from the given openjaus::system::Buffer. More...
virtual int length ()
 Get the number of bytes this message would occupy in a serialized buffer. More...
std::string toXml (unsigned char ojIndentLevel=0) const
 Used to serialize the runtime state of the message to an XML format. More...
std::string toString () const
 Returns a string populated with the Message name and ID More...
void setPresenceVector (uint8_t value)
uint8_t getPresenceVector (void) const
bool isLongitudinalEnabled (void) const
void enableLongitudinal (void)
void disableLongitudinal (void)
bool isLateralEnabled (void) const
void enableLateral (void)
void disableLateral (void)
bool isVerticalEnabled (void) const
void enableVertical (void)
void disableVertical (void)
bool isRollEnabled (void) const
void enableRoll (void)
void disableRoll (void)
bool isPitchEnabled (void) const
void enablePitch (void)
void disablePitch (void)
bool isYawEnabled (void) const
void enableYaw (void)
void disableYaw (void)
uint16_t getReference (void)
bool setReference (uint16_t value)
LongitudinalVariantgetLongitudinal (void)
LateralVariantgetLateral (void)
VerticalVariantgetVertical (void)
RollVariantgetRoll (void)
PitchVariantgetPitch (void)
YawVariantgetYaw (void)
- Public Member Functions inherited from openjaus::model::Message
 Message ()
virtual ~Message ()
 Message (Message *message)
int to (system::Buffer *dst)
 Operation to. More...
int from (system::Buffer *src)
 Operation from. More...
- 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...
virtual Wrapperclone ()
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 Transportable ()
- Public Member Functions inherited from openjaus::system::Prioritized
virtual ~Prioritized ()
- Public Member Functions inherited from openjaus::model::Trigger
 Trigger ()
virtual ~Trigger ()
double getTriggerTimestamp_sec () const
 Accessor to get the value of triggerTimestamp_sec. More...
bool setTriggerTimestamp_sec (double triggerTimestamp_sec)
 Accessor to set value of triggerTimestamp_sec. More...
uint32_t getId () const
 Accessor to get the value of id. More...
bool setId (uint32_t id)
 Accessor to set value of id. More...
std::string idString ()
 Operation idString. More...

Static Public Attributes

static const uint16_t ID = 0x4708
static const uint8_t PV_ALL_FIELDS = 0xFF
static const uint8_t PV_NO_FIELDS = 0x0
static const uint8_t PV_LONGITUDINAL = 0x1
static const uint8_t PV_LATERAL = 0x2
static const uint8_t PV_VERTICAL = 0x4
static const uint8_t PV_ROLL = 0x8
static const uint8_t PV_PITCH = 0x10
static const uint8_t PV_YAW = 0x20

Private Attributes

model::fields::UnsignedShort reference
LongitudinalVariant longitudinal
LateralVariant lateral
VerticalVariant vertical
RollVariant roll
PitchVariant pitch
YawVariant yaw
uint8_t presenceVector


OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportAnalogAction &object)
 OStream operator for Message object More...
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportAnalogAction *object)
 OStream operator for Message pointer More...

Additional Inherited Members

- Protected Member Functions inherited from openjaus::transport::Wrapper
 Wrapper (const Wrapper &wrapper)
- 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
Address source
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
uint32_t id

Detailed Description

This message is used to provide the receiver the current deflection of an analog device.

Constructor & Destructor Documentation

§ ReportAnalogAction() [1/2]

openjaus::hmi::ReportAnalogAction::ReportAnalogAction ( )

§ ReportAnalogAction() [2/2]

openjaus::hmi::ReportAnalogAction::ReportAnalogAction ( model::Message message)

§ ~ReportAnalogAction()

openjaus::hmi::ReportAnalogAction::~ReportAnalogAction ( )

Member Function Documentation

§ disableLateral()

void openjaus::hmi::ReportAnalogAction::disableLateral ( void  )

§ disableLongitudinal()

void openjaus::hmi::ReportAnalogAction::disableLongitudinal ( void  )

§ disablePitch()

void openjaus::hmi::ReportAnalogAction::disablePitch ( void  )

§ disableRoll()

void openjaus::hmi::ReportAnalogAction::disableRoll ( void  )

§ disableVertical()

void openjaus::hmi::ReportAnalogAction::disableVertical ( void  )

§ disableYaw()

void openjaus::hmi::ReportAnalogAction::disableYaw ( void  )

§ enableLateral()

void openjaus::hmi::ReportAnalogAction::enableLateral ( void  )

§ enableLongitudinal()

void openjaus::hmi::ReportAnalogAction::enableLongitudinal ( void  )

§ enablePitch()

void openjaus::hmi::ReportAnalogAction::enablePitch ( void  )

§ enableRoll()

void openjaus::hmi::ReportAnalogAction::enableRoll ( void  )

§ enableVertical()

void openjaus::hmi::ReportAnalogAction::enableVertical ( void  )

§ enableYaw()

void openjaus::hmi::ReportAnalogAction::enableYaw ( void  )

§ from()

int openjaus::hmi::ReportAnalogAction::from ( system::Buffer src)
[in]src- The source openjaus::system::Buffer from which this message will be unpacked.
The number of bytes unpacked from the source buffer

Reimplemented from openjaus::transport::Wrapper.

§ getLateral()

LateralVariant & openjaus::hmi::ReportAnalogAction::getLateral ( void  )

§ getLongitudinal()

LongitudinalVariant & openjaus::hmi::ReportAnalogAction::getLongitudinal ( void  )

§ getPitch()

PitchVariant & openjaus::hmi::ReportAnalogAction::getPitch ( void  )

§ getPresenceVector()

uint8_t openjaus::hmi::ReportAnalogAction::getPresenceVector ( void  ) const

§ getReference()

uint16_t openjaus::hmi::ReportAnalogAction::getReference ( void  )

§ getRoll()

RollVariant & openjaus::hmi::ReportAnalogAction::getRoll ( void  )

§ getVertical()

VerticalVariant & openjaus::hmi::ReportAnalogAction::getVertical ( void  )

§ getYaw()

YawVariant & openjaus::hmi::ReportAnalogAction::getYaw ( void  )

§ isLateralEnabled()

bool openjaus::hmi::ReportAnalogAction::isLateralEnabled ( void  ) const

§ isLongitudinalEnabled()

bool openjaus::hmi::ReportAnalogAction::isLongitudinalEnabled ( void  ) const

§ isPitchEnabled()

bool openjaus::hmi::ReportAnalogAction::isPitchEnabled ( void  ) const

§ isRollEnabled()

bool openjaus::hmi::ReportAnalogAction::isRollEnabled ( void  ) const

§ isVerticalEnabled()

bool openjaus::hmi::ReportAnalogAction::isVerticalEnabled ( void  ) const

§ isYawEnabled()

bool openjaus::hmi::ReportAnalogAction::isYawEnabled ( void  ) const

§ length()

int openjaus::hmi::ReportAnalogAction::length ( void  )
The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

§ setPresenceVector()

void openjaus::hmi::ReportAnalogAction::setPresenceVector ( uint8_t  value)

§ setReference()

bool openjaus::hmi::ReportAnalogAction::setReference ( uint16_t  value)

§ to()

int openjaus::hmi::ReportAnalogAction::to ( system::Buffer dst)
[out]dst- The destination openjaus::system::Buffer to which this message will be packed.
The number of bytes packed into the destination buffer

Reimplemented from openjaus::transport::Wrapper.

§ toString()

std::string openjaus::hmi::ReportAnalogAction::toString ( ) const
The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::hmi::ReportAnalogAction::toXml ( unsigned char  ojIndentLevel = 0) const
[in]ojIndentLevel- Used to determine how many tabs are inserted per line for pretty formating.
The serialized XML string

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ ID

const uint16_t openjaus::hmi::ReportAnalogAction::ID = 0x4708

§ lateral

LateralVariant openjaus::hmi::ReportAnalogAction::lateral

§ longitudinal

LongitudinalVariant openjaus::hmi::ReportAnalogAction::longitudinal

§ pitch

PitchVariant openjaus::hmi::ReportAnalogAction::pitch

§ presenceVector

uint8_t openjaus::hmi::ReportAnalogAction::presenceVector


const uint8_t openjaus::hmi::ReportAnalogAction::PV_ALL_FIELDS = 0xFF


const uint8_t openjaus::hmi::ReportAnalogAction::PV_LATERAL = 0x2


const uint8_t openjaus::hmi::ReportAnalogAction::PV_LONGITUDINAL = 0x1


const uint8_t openjaus::hmi::ReportAnalogAction::PV_NO_FIELDS = 0x0


const uint8_t openjaus::hmi::ReportAnalogAction::PV_PITCH = 0x10


const uint8_t openjaus::hmi::ReportAnalogAction::PV_ROLL = 0x8


const uint8_t openjaus::hmi::ReportAnalogAction::PV_VERTICAL = 0x4


const uint8_t openjaus::hmi::ReportAnalogAction::PV_YAW = 0x20

§ reference

model::fields::UnsignedShort openjaus::hmi::ReportAnalogAction::reference

§ roll

RollVariant openjaus::hmi::ReportAnalogAction::roll

§ vertical

VerticalVariant openjaus::hmi::ReportAnalogAction::vertical

§ yaw

YawVariant openjaus::hmi::ReportAnalogAction::yaw

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