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.

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

virtual const DtSimTaskMessageType &	type () const

virtual DtString	stringRep () const


virtual int	netRepSize () const

virtual bool	setFromNet (const char *buff, unsigned contentSize)

virtual bool	setToNet ()


virtual const DtString &	embeddedEntityName () const

virtual void	setEmbeddedEntityName (const DtString &name)


virtual const DtSetDataRequest *	setToForward () const

virtual void	setSetToForward (const DtSetDataRequest *tsk)

Public Member Functions inherited from DtSimTask
virtual	~DtSimTask ()

virtual bool	init ()

virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)

virtual void	setSubtask (bool flag)

virtual bool	subtask () const

virtual void	setAllowTaskVisualizations (bool flag)

virtual bool	allowTaskVisualizations () const

virtual char *	netRep ()

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimTask *	creator ()

Static Public Member Functions inherited from DtSimTask
static DtSimTask *	createTask (DtlObjPtr mtlStream)

static DtSimTask *	createTask (const DtSimTaskMessageType &taskType)

static void	addTaskCreatorFcn (const DtSimTaskMessageType &taskName, DtSimTaskCreatorFcn fcn)

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 ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual void	putData (std::string &fp, int indentLevel=0)

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

Protected Member Functions inherited from DtSimTask
	DtSimTask ()

	DtSimTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)

	DtSimTask (const DtString &writeName, const DtSimTask &orig, DtReaderWriterRegistry *parentRegistry=0)

const DtSimTask &	operator= (const DtSimTask &orig)

virtual char *	createNetworkBuffer ()

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtRwString	myEmbeddedEntityName

DtSetDataRequest *	mySetToForward

Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask

DtRwBoolean	myAllowTaskVisualizations

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

bool	myInvalid

bool	myChangedFlag

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

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

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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 *	buff,
		unsigned	contentSize
	)

virtual

Framework serialization methods.

Reimplemented from DtSimTask.

virtual bool DtEmbeddedSetForwardTask::setToNet ( )

virtual

Framework serialization methods.

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

Accessor for myEmbeddedEntityName.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrftasks/embeddedSetForwardTask.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation