DtSimCommand Class Reference

DtSimCommand is an abstract base class from which commands can derive. More...

Inheritance diagram for DtSimCommand:

List of all members.

Public Member Functions
virtual	~DtSimCommand ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual int	type () const =0
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
	Make a copy of this sim command.
virtual DtSimCommand *	clone () const
	Version of clone that preserves the existing name, and assigns a null parent registry.
virtual DtString	stringRep () const =0
	Returns a human-readable string representation of the command.
virtual void	putData (FILE *fp, int indentLevel=0)
	putData writes our type, which is provided by the virtual type accessor of the deriving class.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual char *	netRep ()
virtual int	netRepSize () const
	Returns the size in bytes of the network representation of the class.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.
Static Public Member Functions
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
	Static functions.
static DtSimCommand *	createSimCommand (int simCommandType)
static void	addSimCommandCreatorFcn (const DtString &simCommandName, int simCommandType, DtSimCommandCreatorFcn fcn)
	Adds a simCommand creator member function to the simCommand factory.
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
static bool	getSimCommandNameFromSimCommandType (int simCommandType, DtString &simCommandName)
static bool	getSimCommandTypeFromSimCommandName (const DtString &simCommandName, int &simCommandType)
static bool	addSimCommandTypeMapping (const DtString &simCommandName, int simCommandType)
static bool	removeSimCommandTypeMapping (const DtString &simCommandName, int simCommandType)
Protected Member Functions
	DtSimCommand ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a command 'put' itself, the write name will preface the command.
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimCommand &	operator= (const DtSimCommand &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
Protected Attributes
char *	myNetRep
Static Protected Attributes
static DtSimCommandFactory *	myFactory
static DtStringIntMapper	theSimCommandNameMapper

---

Detailed Description

DtSimCommand is an abstract base class from which commands can derive.

It manages the read/write capability; derived classes need only use and register read/writable data types for derived information.

Examples

• Add Simulation Command Example

---

Constructor & Destructor Documentation

DtSimCommand::DtSimCommand

(

)

[protected]

Constructors are protected because no one should instantiate the base class, just derived versions.

default constructor

DtSimCommand::DtSimCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

constructor If you have a command 'put' itself, the write name will preface the command.

DtSimCommand::DtSimCommand	(	const DtString &	writeName,
		const DtSimCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

copy constructor

virtual DtSimCommand::~DtSimCommand

(

)

[virtual]

destructor

---

Member Function Documentation

const DtSimCommand& DtSimCommand::operator=

(

const DtSimCommand &

orig

)

[protected]

assignment operator; same as copy constructor

virtual bool DtSimCommand::init

(

)

[virtual]

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

virtual int DtSimCommand::type

(

)

const [pure virtual]

Returns:

An integer the kind of simulation command. Derived classes must implement this member function to return a unique string representing the type of simCommand. The set of standard simCommand types supplied with VR-Forces is in radioMsgsTypes.h.

Implemented in DtCreateObjectCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtChangeGlobalWeatherCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, MySimCommand, DtChangeHostilityCommand, DtChangeTimeOfDayCommand, DtIssuePlanCommand, DtStealthCompassCommand, DtStealthDetachCommand, DtStealthGroupCommand, DtStealthMimicCommand, and DtNoopCommand.

virtual DtSimCommand* DtSimCommand::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [pure virtual]

Make a copy of this sim command.

Returns a newly allocated instance of a DtSimCommand. Override this member function to return a pointer to a newly allocated instance of the derived class.

Implemented in DtCreateObjectCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtChangeGlobalWeatherCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, MySimCommand, DtChangeHostilityCommand, DtChangeTimeOfDayCommand, DtIssuePlanCommand, DtNoopCommand, DtStealthCompassCommand, DtStealthDetachCommand, DtStealthGroupCommand, and DtStealthMimicCommand.

virtual DtSimCommand* DtSimCommand::clone

(

)

const [virtual]

Version of clone that preserves the existing name, and assigns a null parent registry.

virtual DtString DtSimCommand::stringRep

(

)

const [pure virtual]

Returns a human-readable string representation of the command.

This string representation is used to display information about the command in the plan editor and viewer. The type and parameters for the command are typically encoded in the string. The format of the string is up to you.

Implemented in DtChangeGlobalWeatherCommand, DtCreateObjectCommand, DtChangeTimeOfDayCommand, DtStealthCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtChangeHostilityCommand, DtConsoleMessageCommand, DtIssuePlanCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, MySimCommand, DtStealthCompassCommand, DtStealthDetachCommand, DtStealthGroupCommand, DtStealthMimicCommand, and DtNoopCommand.

virtual void DtSimCommand::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[virtual]

putData writes our type, which is provided by the virtual type accessor of the deriving class.

Reimplemented from DtReaderWriter.

Reimplemented in DtSetDataCommand, and DtTaskCommand.

virtual DtlObjPtr DtSimCommand::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

getData is just used to get us past the type in the data stream, since it's not actually stored.

Reimplemented in DtSetDataCommand, and DtTaskCommand.

virtual char* DtSimCommand::netRep

(

)

[virtual]

virtual int DtSimCommand::netRepSize

(

)

const [virtual]

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented in DtCreateObjectCommand, DtStealthCommand, DtChangeHostilityCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtIssuePlanCommand, MySimCommand, DtChangeGlobalWeatherCommand, DtChangeTimeOfDayCommand, and DtNoopCommand.

virtual bool DtSimCommand::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented in DtCreateObjectCommand, DtStealthCommand, DtChangeHostilityCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtAbandonPlanCommand, DtRestartPlanCommand, MySimCommand, DtIssuePlanCommand, DtChangeGlobalWeatherCommand, DtNoopCommand, and DtChangeTimeOfDayCommand.

virtual bool DtSimCommand::setToNet

(

)

[virtual]

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented in DtCreateObjectCommand, DtStealthCommand, DtChangeHostilityCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, MySimCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtIssuePlanCommand, DtChangeGlobalWeatherCommand, DtNoopCommand, and DtChangeTimeOfDayCommand.

static DtSimCommand* DtSimCommand::createSimCommand

(

DtlObjPtr

mtlStream

)

[static]

Static functions.

Creates a new simCommand, given a pointer to a MAK Technologies LISP (MTL) stream. It first parses the stream to extract the type of simCommand to create. Then it calls the simCommand factory's create() member function with the given simCommand type. This returns a new instance of the particular simCommand type. The simCommand's getData() member function is then called to retrieve the simCommand parameters from the stream. The pointer to the new simCommand is returned.

static DtSimCommand* DtSimCommand::createSimCommand

(

int

simCommandType

)

[static]

static void DtSimCommand::addSimCommandCreatorFcn	(	const DtString &	simCommandName,
		int	simCommandType,
		DtSimCommandCreatorFcn	fcn
	)		[static]

Adds a simCommand creator member function to the simCommand factory.

static void DtSimCommand::setFactory

(

DtSimCommandFactory *

factory

)

[static]

static DtSimCommandFactory* DtSimCommand::factory

(

)

[static]

Returns:

A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

static bool DtSimCommand::getSimCommandNameFromSimCommandType	(	int	simCommandType,
		DtString &	simCommandName
	)		[static]

static bool DtSimCommand::getSimCommandTypeFromSimCommandName	(	const DtString &	simCommandName,
		int &	simCommandType
	)		[static]

static bool DtSimCommand::addSimCommandTypeMapping	(	const DtString &	simCommandName,
		int	simCommandType
	)		[static]

static bool DtSimCommand::removeSimCommandTypeMapping	(	const DtString &	simCommandName,
		int	simCommandType
	)		[static]

virtual char* DtSimCommand::createNetworkBuffer

(

)

[protected, virtual]

---

Member Data Documentation

char* DtSimCommand::myNetRep [protected]

DtSimCommandFactory* DtSimCommand::myFactory [static, protected]

DtStringIntMapper DtSimCommand::theSimCommandNameMapper [static, protected]

---

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

• include/vrfplan/simCommand.h