This message is used to report the current state of this service. If the service is in the Controlled state, this message reports the ID of the controlling component. The ID fields shall be set to zero (0) if this service is in the NotControlled state. More...
#include <reportcontrol.h>
Classes | |
| class | Limits |
| Contains limits of specific fields in message. More... | |
Public Member Functions | |
| ReportControl (const Address &dest=Address(), const Address &src=Address()) | |
| Constructor, initializes default values. | |
| ReportControl (const ReportControl &message) | |
| Copy constructor. | |
| ~ReportControl () | |
| Destructor. | |
| bool | SetControllingComponent (const Address &controller) |
| Sets the Address of controlling component. | |
| Address | GetControllingComponent () const |
| void | SetAuthorityCode (const Byte code) |
| Byte | GetAuthorityCode () const |
| virtual bool | IsCommand () const |
| virtual int | WriteMessageBody (Packet &packet) const |
| Writes message payload to the packet. | |
| virtual int | ReadMessageBody (const Packet &packet) |
| Reads message payload from the packet. | |
| virtual Message * | Clone () const |
| virtual UInt | GetPresenceVector () const |
| virtual UInt | GetPresenceVectorSize () const |
| virtual UInt | GetPresenceVectorMask () const |
| virtual UShort | GetMessageCodeOfResponse () const |
| virtual std::string | GetMessageName () const |
| virtual void | ClearMessageBody () |
| Clears message payload data. | |
| virtual bool | IsLargeDataSet (const unsigned int maxPayloadSize=1437) const |
| virtual int | RunTestCase () const |
| Runs a test case to validate the message class. | |
| ReportControl & | operator= (const ReportControl &message) |
| Sets equal to. | |
Protected Attributes | |
| Address | mControllingComponent |
| Address value of the current controlling component. | |
| Byte | mAuthorityCode |
| Authority value of sending component [0,255]. | |
This message is used to report the current state of this service. If the service is in the Controlled state, this message reports the ID of the controlling component. The ID fields shall be set to zero (0) if this service is in the NotControlled state.
Definition at line 57 of file reportcontrol.h.
Constructor, initializes default values.
| [in] | src | Source ID of message sender. |
| [in] | dest | Destination ID of message. |
Definition at line 56 of file reportcontrol.cpp.
| ReportControl::ReportControl | ( | const ReportControl & | message ) |
Copy constructor.
Definition at line 68 of file reportcontrol.cpp.
| ReportControl::~ReportControl | ( | ) |
Destructor.
Definition at line 79 of file reportcontrol.cpp.
| void ReportControl::ClearMessageBody | ( | ) | [virtual] |
Clears message payload data.
Implements JAUS::Message.
Definition at line 153 of file reportcontrol.cpp.
| virtual Message* JAUS::ReportControl::Clone | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 82 of file reportcontrol.h.
| Byte JAUS::ReportControl::GetAuthorityCode | ( | ) | const [inline] |
Definition at line 78 of file reportcontrol.h.
| Address JAUS::ReportControl::GetControllingComponent | ( | ) | const [inline] |
Definition at line 76 of file reportcontrol.h.
| virtual UShort JAUS::ReportControl::GetMessageCodeOfResponse | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 86 of file reportcontrol.h.
| virtual std::string JAUS::ReportControl::GetMessageName | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 87 of file reportcontrol.h.
| virtual UInt JAUS::ReportControl::GetPresenceVector | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 83 of file reportcontrol.h.
| virtual UInt JAUS::ReportControl::GetPresenceVectorMask | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 85 of file reportcontrol.h.
| virtual UInt JAUS::ReportControl::GetPresenceVectorSize | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 84 of file reportcontrol.h.
| virtual bool JAUS::ReportControl::IsCommand | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 79 of file reportcontrol.h.
| virtual bool JAUS::ReportControl::IsLargeDataSet | ( | const unsigned int | maxPayloadSize = 1437 ) |
const [inline, virtual] |
Implements JAUS::Message.
Definition at line 89 of file reportcontrol.h.
| ReportControl & ReportControl::operator= | ( | const ReportControl & | message ) |
Sets equal to.
Definition at line 193 of file reportcontrol.cpp.
| int ReportControl::ReadMessageBody | ( | const Packet & | packet ) | [virtual] |
Reads message payload from the packet.
Message contents are read from the packet following the JAUS standard.
| [in] | packet | Packet containing message payload data to read. |
Implements JAUS::Message.
Definition at line 134 of file reportcontrol.cpp.
| int ReportControl::RunTestCase | ( | ) | const [virtual] |
Runs a test case to validate the message class.
Reimplemented from JAUS::Message.
Definition at line 167 of file reportcontrol.cpp.
| void JAUS::ReportControl::SetAuthorityCode | ( | const Byte | code ) | [inline] |
Definition at line 77 of file reportcontrol.h.
| bool ReportControl::SetControllingComponent | ( | const Address & | controller ) |
Sets the Address of controlling component.
Definition at line 91 of file reportcontrol.cpp.
| int ReportControl::WriteMessageBody | ( | Packet & | packet ) | const [virtual] |
Writes message payload to the packet.
Message contents are written to the packet following the JAUS standard.
| [out] | packet | Packet to write payload to. |
Implements JAUS::Message.
Definition at line 109 of file reportcontrol.cpp.
Byte JAUS::ReportControl::mAuthorityCode [protected] |
Authority value of sending component [0,255].
Definition at line 94 of file reportcontrol.h.
Address JAUS::ReportControl::mControllingComponent [protected] |
Address value of the current controlling component.
Definition at line 93 of file reportcontrol.h.
1.7.2
