This message is used add, insert or replace one or more elements in a list. Each element is uniquely identified by the UID, and the sequence within the list is specified by the previous (parent) and next (child) elements. This message can be used to update an existing element. More...
#include <setelement.h>
Public Member Functions | |
| SetElement (const Address &dest=Address(), const Address &src=Address()) | |
| Constructor, initializes default values. | |
| SetElement (const SetElement &message) | |
| Copy constructor. | |
| ~SetElement () | |
| Destructor. | |
| Byte | GetRequestID () const |
| Byte | SetRequestID (const Byte rid) |
| Element::List * | GetElementList () |
| const Element::List * | GetElementList () 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 contents. | |
| virtual bool | IsLargeDataSet (const unsigned int maxPayloadSize=1437) const |
| Checks to see if the message will be part of a large data set. | |
| virtual int | RunTestCase () const |
| Runs a test case to validate the message class. | |
| SetElement & | operator= (const SetElement &message) |
| Sets equal to. | |
Protected Attributes | |
| Byte | mRequestID |
| ID of request to be returned in response message. | |
| Element::List | mElements |
| List of elements to be added, inserted, or replaced. | |
This message is used add, insert or replace one or more elements in a list. Each element is uniquely identified by the UID, and the sequence within the list is specified by the previous (parent) and next (child) elements. This message can be used to update an existing element.
Definition at line 58 of file setelement.h.
Constructor, initializes default values.
| [in] | src | Source ID of message sender. |
| [in] | dest | Destination ID of message. |
Definition at line 53 of file setelement.cpp.
| SetElement::SetElement | ( | const SetElement & | message ) |
Copy constructor.
Definition at line 64 of file setelement.cpp.
| SetElement::~SetElement | ( | ) |
Destructor.
Definition at line 76 of file setelement.cpp.
| void SetElement::ClearMessageBody | ( | ) | [virtual] |
| virtual Message* JAUS::SetElement::Clone | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 71 of file setelement.h.
| Element::List* JAUS::SetElement::GetElementList | ( | ) | [inline] |
Definition at line 66 of file setelement.h.
| const Element::List* JAUS::SetElement::GetElementList | ( | ) | const [inline] |
Definition at line 67 of file setelement.h.
| virtual UShort JAUS::SetElement::GetMessageCodeOfResponse | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 75 of file setelement.h.
| virtual std::string JAUS::SetElement::GetMessageName | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 76 of file setelement.h.
| virtual UInt JAUS::SetElement::GetPresenceVector | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 72 of file setelement.h.
| virtual UInt JAUS::SetElement::GetPresenceVectorMask | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 74 of file setelement.h.
| virtual UInt JAUS::SetElement::GetPresenceVectorSize | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 73 of file setelement.h.
| Byte JAUS::SetElement::GetRequestID | ( | ) | const [inline] |
Definition at line 64 of file setelement.h.
| virtual bool JAUS::SetElement::IsCommand | ( | ) | const [inline, virtual] |
Implements JAUS::Message.
Definition at line 68 of file setelement.h.
| bool SetElement::IsLargeDataSet | ( | const unsigned int | maxPayloadSize = 1437 ) |
const [virtual] |
Checks to see if the message will be part of a large data set.
Implements JAUS::Message.
Definition at line 195 of file setelement.cpp.
| SetElement & SetElement::operator= | ( | const SetElement & | message ) |
Sets equal to.
Definition at line 285 of file setelement.cpp.
| int SetElement::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 145 of file setelement.cpp.
| int SetElement::RunTestCase | ( | ) | const [virtual] |
Runs a test case to validate the message class.
Reimplemented from JAUS::Message.
Definition at line 232 of file setelement.cpp.
Definition at line 65 of file setelement.h.
| int SetElement::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 92 of file setelement.cpp.
Element::List JAUS::SetElement::mElements [protected] |
List of elements to be added, inserted, or replaced.
Definition at line 83 of file setelement.h.
Byte JAUS::SetElement::mRequestID [protected] |
ID of request to be returned in response message.
Definition at line 82 of file setelement.h.
1.7.2
