The DtEmbeddedSetForwardTask is a task container for DtSetDataRequest instances which are addressed to an Embedded Entity name as defined in a DtRwEmbeddedEntity instance (in a .sysdef) and then translated and forwarded to the actual sim object by the DTEmbeddedEntitiesController. More...

Inheritance diagram for DtEmbeddedSetForwardTask:

[legend]

Public Member Functions
	DtEmbeddedSetForwardTask ()
	DtEmbeddedSetForwardTask (const DtString &mtlName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtEmbeddedSetForwardTask (const DtString &mtlName, const DtEmbeddedSetForwardTask &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	~DtEmbeddedSetForwardTask ()
DtEmbeddedSetForwardTask &	operator= (const DtEmbeddedSetForwardTask &orig)
virtual DtSimTask *	clone (const DtString &mtlName, DtReaderWriterRegistry *parentRegistry=NULL) const
	Make a copy of this task.
virtual const DtSimTaskMessageType &	type () const
	What kind of task am I? Returns a string indicating the kind of task (for example, �move-to�, �follow-entity�).
virtual DtString	stringRep () const
	Returns a string representation of this task (for Info dialogs etc.)

virtual int	netRepSize () const
	Framework serialization methods.
virtual bool	setFromNet (const char *buff, unsigned contentSize)
	Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
virtual bool	setToNet ()
	Calls netRep() to create the network buffer.

virtual const DtString &	embeddedEntityName () const
	Accessor for myEmbeddedEntityName.
virtual void	setEmbeddedEntityName (const DtString &name)

virtual const DtSetDataRequest *	setToForward () const
	Accessor for mySetToForward.
virtual void	setSetToForward (const DtSetDataRequest *tsk)
	Clones the set request passed in and stores it.
Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()
	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 bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
virtual char *	netRep ()
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 (std::string &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 (std::string &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.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original 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 bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
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 ()
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 ()
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 &)
	Restores 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 DtSimTask *	creator ()
Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)
	Static functions.
static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)
static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)
	Adds a task creator member function to the task factory.
static void	setFactory (DtSimTaskFactory *factory)
static DtSimTaskFactory *	factory ()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
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 &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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
virtual void	putData (std::string &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.
Protected Member Functions inherited from DtSimTask
	DtSimTask ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the write name will preface the task.
	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtSimTask &	operator= (const DtSimTask &orig)
	assignment operator; same as copy constructor
virtual char *	createNetworkBuffer ()
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
DtRwString	myEmbeddedEntityName
DtSetDataRequest *	mySetToForward
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
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.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

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 )()
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

The DtEmbeddedSetForwardTask is a task container for DtSetDataRequest instances which are addressed to an Embedded Entity name as defined in a DtRwEmbeddedEntity instance (in a .sysdef) and then translated and forwarded to the actual sim object by the DTEmbeddedEntitiesController.

Constructor & Destructor Documentation

DtEmbeddedSetForwardTask::DtEmbeddedSetForwardTask ( )

DtEmbeddedSetForwardTask::DtEmbeddedSetForwardTask	(	const DtString &	mtlName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtEmbeddedSetForwardTask::DtEmbeddedSetForwardTask	(	const DtString &	mtlName,
		const DtEmbeddedSetForwardTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtEmbeddedSetForwardTask::~DtEmbeddedSetForwardTask ( )

Member Function Documentation

DtEmbeddedSetForwardTask& DtEmbeddedSetForwardTask::operator= ( const DtEmbeddedSetForwardTask & orig )

virtual DtSimTask* DtEmbeddedSetForwardTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Make a copy of this task.

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

Implements DtSimTask.

virtual const DtSimTaskMessageType& DtEmbeddedSetForwardTask::type ( ) const

virtual

What kind of task am I? Returns a string indicating the kind of task (for example, �move-to�, �follow-entity�).

Derived classes must implement this member function to return a unique string representing the type of task. The set of standard task types supplied with VR-Forces is in taskTypes.h.

Implements DtSimTask.

static DtSimTask* DtEmbeddedSetForwardTask::creator ( )

static

virtual int DtEmbeddedSetForwardTask::netRepSize ( ) const

virtual

Framework serialization methods.

Reimplemented from DtSimTask.

virtual bool DtEmbeddedSetForwardTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

virtual

Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).

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

Reimplemented from DtSimTask.

virtual bool DtEmbeddedSetForwardTask::setToNet ( )

virtual

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. 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 + DtSimTask::netRepSize().

Reimplemented from DtSimTask.

virtual DtString DtEmbeddedSetForwardTask::stringRep ( ) const

virtual

Returns a string representation of this task (for Info dialogs etc.)

Implements DtSimTask.

virtual const DtString& DtEmbeddedSetForwardTask::embeddedEntityName ( ) const

virtual

Accessor for myEmbeddedEntityName.

virtual void DtEmbeddedSetForwardTask::setEmbeddedEntityName ( const DtString & name )

virtual

virtual const DtSetDataRequest* DtEmbeddedSetForwardTask::setToForward ( ) const

virtual

Accessor for mySetToForward.

virtual void DtEmbeddedSetForwardTask::setSetToForward ( const DtSetDataRequest * tsk )

virtual

Clones the set request passed in and stores it.

virtual void DtEmbeddedSetForwardTask::putData	(	std::string &	fp,
		int	indentLevel = `0`
	)

protectedvirtual

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

Reimplemented from DtSimTask.

virtual DtlObjPtr DtEmbeddedSetForwardTask::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

protectedvirtual

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

Reimplemented from DtSimTask.

Member Data Documentation

DtRwString DtEmbeddedSetForwardTask::myEmbeddedEntityName

protected

DtSetDataRequest* DtEmbeddedSetForwardTask::mySetToForward

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrftasks/embeddedSetForwardTask.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation