DtSimCommand Class Reference

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

Inheritance diagram for DtSimCommand:

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 const DtSimCommandMessageType &	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 DtReaderWriter::SearchPaths &searchPaths, 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.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
	Static functions.
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
	Adds a simCommand creator member function to the simCommand factory.
static void	setFactory (DtSimCommandFactory *factory)
static DtSimCommandFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

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 ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Static Protected Attributes
static DtSimCommandFactory *	myFactory
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()

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 const DtSimCommandMessageType& 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, DtScenarioEventCommand, DtStealthCommandCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtChangeWeatherCommand, DtConsoleMessageCommand, DtChangeGlobalWeatherCommand, DtSetDataCommand, DtTaskCommand, DtChangeHostilityCommand, DtDeleteObjectCommand, DtIssuePlanCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtChangeTimeOfDayCommand, 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, DtScenarioEventCommand, DtStealthCommandCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtChangeWeatherCommand, DtConsoleMessageCommand, DtChangeGlobalWeatherCommand, DtSetDataCommand, DtTaskCommand, DtChangeHostilityCommand, DtDeleteObjectCommand, DtIssuePlanCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtChangeTimeOfDayCommand, and DtNoopCommand.

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 DtChangeWeatherCommand, DtCreateObjectCommand, DtChangeTimeOfDayCommand, DtScenarioEventCommand, DtAbandonPlanCommand, DtChangeHostilityCommand, DtRestartPlanCommand, DtConsoleMessageCommand, DtIssuePlanCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtStealthCommandCommand, 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 DtReaderWriter::SearchPaths &  searchPaths, 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, DtScenarioEventCommand, DtChangeHostilityCommand, DtConsoleMessageCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtIssuePlanCommand, DtStealthCommandCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtChangeWeatherCommand, 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, DtChangeHostilityCommand, DtConsoleMessageCommand, DtScenarioEventCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtAbandonPlanCommand, DtRestartPlanCommand, DtIssuePlanCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtStealthCommandCommand, DtChangeWeatherCommand, 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, DtChangeHostilityCommand, DtConsoleMessageCommand, DtScenarioEventCommand, DtDeleteObjectCommand, DtSetDataCommand, DtTaskCommand, DtAbandonPlanCommand, DtLaunchGlobalPlanCommand, MySimCommand, DtRestartPlanCommand, DtIssuePlanCommand, DtStealthCommandCommand, DtChangeWeatherCommand, 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 ( const DtSimCommandMessageType &  simCommandType )

static

static void DtSimCommand::addSimCommandCreatorFcn ( const DtSimCommandMessageType &  simCommandName, 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.

virtual char* DtSimCommand::createNetworkBuffer ( )

protectedvirtual

virtual bool DtSimCommand::isTypeRegistered ( const DtSimCommandMessageType &  commandType )

protectedvirtual

Member Data Documentation

char* DtSimCommand::myNetRep

protected

DtSimCommandFactory* DtSimCommand::myFactory

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfplan/simCommand.h