activemq::commands::PartialCommand Class Reference
#include <src/main/activemq/commands/PartialCommand.h>
Public Member Functions | |
| PartialCommand () | |
| virtual | ~PartialCommand () |
| virtual unsigned char | getDataStructureType () const |
| Get the DataStructure Type as defined in CommandTypes.h. | |
| virtual PartialCommand * | cloneDataStructure () const |
| Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one. | |
| virtual void | copyDataStructure (const DataStructure *src) |
| Copy the contents of the passed object into this objects members, overwriting any existing data. | |
| virtual std::string | toString () const |
| Returns a string containing the information for this DataStructure such as its type and value of its elements. | |
| virtual bool | equals (const DataStructure *value) const |
| Compares the DataStructure passed in to this one, and returns if they are equivalent. | |
| virtual int | getCommandId () const |
| virtual void | setCommandId (int commandId) |
| virtual const std::vector < unsigned char > & | getData () const |
| virtual std::vector< unsigned char > & | getData () |
| virtual void | setData (const std::vector< unsigned char > &data) |
Static Public Attributes | |
| static const unsigned char | ID_PARTIALCOMMAND = 60 |
Protected Attributes | |
| int | commandId |
| std::vector< unsigned char > | data |
Constructor & Destructor Documentation
| activemq::commands::PartialCommand::PartialCommand | ( | ) |
| virtual activemq::commands::PartialCommand::~PartialCommand | ( | ) | [virtual] |
Member Function Documentation
| virtual PartialCommand* activemq::commands::PartialCommand::cloneDataStructure | ( | ) | const [virtual] |
Clone this obbject and return a new instance that the caller now owns, this will be an exact copy of this one.
- Returns:
- new copy of this object.
Implements activemq::commands::DataStructure.
Reimplemented in activemq::commands::LastPartialCommand.
| virtual void activemq::commands::PartialCommand::copyDataStructure | ( | const DataStructure * | src | ) | [virtual] |
Copy the contents of the passed object into this objects members, overwriting any existing data.
- Returns:
- src - Source Object
Implements activemq::commands::DataStructure.
Reimplemented in activemq::commands::LastPartialCommand.
| virtual bool activemq::commands::PartialCommand::equals | ( | const DataStructure * | value | ) | const [virtual] |
Compares the DataStructure passed in to this one, and returns if they are equivalent.
Equivalent here means that they are of the same type, and that each element of the objects are the same.
- Returns:
- true if DataStructure's are Equal.
Implements activemq::commands::DataStructure.
Reimplemented in activemq::commands::LastPartialCommand.
| virtual int activemq::commands::PartialCommand::getCommandId | ( | ) | const [virtual] |
| virtual std::vector<unsigned char>& activemq::commands::PartialCommand::getData | ( | ) | [virtual] |
| virtual const std::vector<unsigned char>& activemq::commands::PartialCommand::getData | ( | ) | const [virtual] |
| virtual unsigned char activemq::commands::PartialCommand::getDataStructureType | ( | ) | const [virtual] |
Get the DataStructure Type as defined in CommandTypes.h.
- Returns:
- The type of the data structure
Implements activemq::commands::DataStructure.
Reimplemented in activemq::commands::LastPartialCommand.
| virtual void activemq::commands::PartialCommand::setCommandId | ( | int | commandId | ) | [virtual] |
| virtual void activemq::commands::PartialCommand::setData | ( | const std::vector< unsigned char > & | data | ) | [virtual] |
| virtual std::string activemq::commands::PartialCommand::toString | ( | ) | const [virtual] |
Returns a string containing the information for this DataStructure such as its type and value of its elements.
- Returns:
- formatted string useful for debugging.
Reimplemented from activemq::commands::BaseDataStructure.
Reimplemented in activemq::commands::LastPartialCommand.
Field Documentation
int activemq::commands::PartialCommand::commandId [protected] |
std::vector<unsigned char> activemq::commands::PartialCommand::data [protected] |
const unsigned char activemq::commands::PartialCommand::ID_PARTIALCOMMAND = 60 [static] |
The documentation for this class was generated from the following file:
- src/main/activemq/commands/PartialCommand.h
