CommandObject Class Reference

Inherited by ExternalEntryCommandObject, IEntryCommandObject, and MultipleIEntryCommandObject.

List of all members.

---

Detailed Description

The CommandObject is the universal container for Exchanging data between Java and CPP workers.

The CommandObject contains a Command followed by parameters and optionally ExternalEntry Serializations and object MetaData.

Public Types
enum	Content {   HasEntry = 1, HasEntryVector = 2, HasMetaData = 4, HasEntryTemplate = 8,   Reserverd3 = 16, Reserverd4 = 32, Reserverd5 = 64, Reserverd6 = 128 }
Public Member Functions
virtual void	clean ()
	CommandObject (BinaryReader &stream)
	Constructs a CommandObject from a PBS serialization packet.
	CommandObject (const std::string &command, const genericVector &Parameters)
	Constructs a CommandObject which contains just a parameter list.
virtual CommandObject *	CreateCommandRetValue (BinaryReader &stream)
std::string	getCommand ()
	getCommand, return the string encoded Command name of this CommandObject.
SpaceMetaDataPtr	getMetaData ()
	getMetaData.
genericVector &	getParameters ()
	getParameters, return the genericVector of Parameters associated with this CommandObject.
bool	hasExternalEntry ()
bool	hasExternalEntryVector ()
bool	hasMetaData ()
	hasMetaData.
SpaceMetaDataPtr	readMetaData (BinaryReader &stream)
	readMetaData.
bool	readParameters (BinaryReader &stream)
	readParameters.
virtual void	toWireForm (BinaryWriter &stream)
	toWireForm serialize the given CommandObject onto a stream in PBS format
bool	writeMetaData (BinaryWriter &stream, SpaceMetaDataPtr metaData)
	writeMetaData.
bool	writeParameters (BinaryWriter &stream)
	writeParameters.
virtual	~CommandObject ()
	CommandObject destructor.
Static Public Member Functions
static int	toPbsCode (const std::type_info &type)
	toPbsCode.
Protected Attributes
std::string	m_command
bool	m_hasMetaData
SpaceMetaDataPtr	m_metaData
genericVector	m_parameters

---

Constructor & Destructor Documentation

CommandObject::CommandObject	(	const std::string &	command,
		const genericVector &	Parameters
	)

Constructs a CommandObject which contains just a parameter list.

Parameters:

	std::string	command, name of the command to be executed within the host process.
	genericVector	parameters, a vector of typed parameters that will be serialized to pbs on the stream

CommandObject::CommandObject

(

BinaryReader &

stream

)

Constructs a CommandObject from a PBS serialization packet.

Parameters:

BinaryReader&

stream the packaged pbs stream.

Since:

1.0

See also:

BinaryReader

CommandObject::~CommandObject

(

)

[virtual]

CommandObject destructor.

Since:

1.0

---

Member Function Documentation

std::string CommandObject::getCommand

(

)

getCommand, return the string encoded Command name of this CommandObject.

Since:

1.0

Returns:

The string encoded command stored within the CommandObject or an empty genericVector if none exist

SpaceMetaDataPtr CommandObject::getMetaData

(

)

getMetaData.

Reads the metaData for a given object passed back from the Space very useful debugging aid.

Returns:

SpaceMetaDataPtr.

Since:

1.0

genericVector & CommandObject::getParameters

(

)

getParameters, return the genericVector of Parameters associated with this CommandObject.

Since:

1.0

Returns:

The contained parameters stored within the CommandObject or an empty genericVector if none exist

See also:

genericVector

bool CommandObject::hasMetaData

(

)

hasMetaData.

Indicates if this commandObject contains any MetaData

Returns:

bool true if this CommandObject contains any MetaData otherwise false.

Since:

1.0

SpaceMetaDataPtr CommandObject::readMetaData

(

BinaryReader &

stream

)

readMetaData.

Reads the metaData for a given object passed back from the Space very useful debugging aid.

Returns:

SpaceMetaDataPtr.

Since:

1.0

bool CommandObject::readParameters

(

BinaryReader &

stream

)

readParameters.

reads the genericVector of parameters from the given stream

Returns:

bool success or failure

Since:

1.0

int CommandObject::toPbsCode

(

const std::type_info &

type

)

[static]

toPbsCode.

Converts from C type code to internal PBS data type.

Returns:

int internal PBS type code.

Since:

1.0

void CommandObject::toWireForm

(

BinaryWriter &

stream

)

[virtual]

toWireForm serialize the given CommandObject onto a stream in PBS format

Parameters:

BinaryWriter&

stream, a suitable stream to push the object onto.

Since:

1.0

See also:

BinaryWriter

bool CommandObject::writeMetaData	(	BinaryWriter &	stream,
		SpaceMetaDataPtr	metaData
	)

writeMetaData.

writes the MetaData object onto the stream in PBS format

Parameters:

	BinaryWriter&	stream
	SpaceMetaDataPtr	metaData

Since:

1.0

bool CommandObject::writeParameters

(

BinaryWriter &

stream

)

writeParameters.

Writes the genericVector of parameters onto the given stream

Returns:

bool success or failure

Since:

1.0

---