DtSimTask Class Reference

DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capability; derived classes need only use and register read/writable data types for derived information.

Related examples

• Add Task Example demonstrates user tasks.

Other uses in examples

• Entity List

Inherits DtReaderWriter.

Inherited by DtBreachTask, DtConvoyAlongTask, DtConvoyToTask, DtCrashIntoTask, DtDiGuyAnimationTask, DtDiGuyGestureTask, DtDisembarkAllTask, DtDisembarkTask, DtEmbarkTask, DtEmbeddedSetForwardTask, DtEmbeddedTaskForwardTask, DtFireAtTargetTask, DtFireBallisticGunTask, DtFireCruiseMissileTask, DtFireForEffectTask, DtFireLaserGuidedMissileTask, DtFireMissileLauncherTask, DtFlyAlongTask, DtFlyAltitudeTask, DtFlyHeadingAndAltitudeTask, DtFlyHeadingTask, DtFlyToLocationTask, DtFollowEntityTask, DtHoldUntilTask, DtIffInterrogatorSweepTask, DtIffInterrogatorTask, DtInternalTransferFuelTask, DtKeepStationTask, DtLandingTask, DtLaseLocationTask, DtLaseTargetTask, DtLaunchExpendableResourceTask, DtLaunchSmokeTask, DtMoveAlongTask, DtMoveIntoFormationTask, DtMoveToAltitudeTask, DtMoveToDestinationTask, DtMoveToLocationTask, DtMoveToTask, DtOrbitTask, DtPatrolRouteTask, DtPatrolTwoPointsTask, DtRailMoveAlongTask, DtRailPathTask, DtRailRouteTask, DtReleaseBombTask, DtScriptedMovementTask, DtScriptedTaskTemplate< DtSimTask >, DtSendSetMessageTask, DtSendTaskMessageTask, DtSendTextTask, DtStopMovingTask, DtTakeoffTask, DtTargetEntityTask, DtTargetPointTask, DtTransferSuppliesTask, DtTurnToHeadingTask, DtUserTask, DtVerticalLandingTask, DtWaitDurationTask, DtWaitElapsedTask, and DtWaitTask.

Public Member Functions
virtual	~DtSimTask ()
virtual bool	init ()
virtual const DtSimTaskMessageType &	type () const =0
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
virtual DtString	stringRep () const =0
virtual void	setSubtask (bool flag)
virtual bool	subtask () const
virtual void	setAllowTaskVisualizations (bool flag)
virtual bool	allowTaskVisualizations () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
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) const
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	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 *	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
	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
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

Static Protected Attributes
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

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

Constructor & Destructor Documentation

DtSimTask::DtSimTask ( )

protected

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

default constructor

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

protected

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

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

protected

copy constructor

virtual DtSimTask::~DtSimTask ( )

virtual

destructor

Member Function Documentation

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

protected

assignment operator; same as copy constructor

virtual bool DtSimTask::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.

Reimplemented in DtScriptedTaskTemplate< DtSimTask >.

virtual const DtSimTaskMessageType& DtSimTask::type ( ) const

pure 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.

Implemented in DtScriptedTaskTask, DtFlyHeadingAndAltitudeTask, DtMoveAlongWithActionsTask, DtMoveAlongRetrogradeTask, DtMoveToRetrogradeTask, DtMoveToLocationRetrogradeTask, DtFlyHeadingTask, DtKeepStationTask, DtFollowEntityTask, DtUserTask, DtRailMoveAlongTask, DtMoveToTask, DtMoveAlongTask, DtWaitElapsedTask, DtRailPathTask, DtRailRouteTask, DtWaitDurationTask, DtPatrolRouteTask, DtPatrolTwoPointsTask, DtFlyAlongTask, DtTurnToHeadingTask, DtTakeoffTask, DtWaitTask, DtEmbarkTask, DtMoveToAltitudeTask, DtFlyToLocationTask, DtPlanAndMoveToLocationTask, DtConvoyToTask, DtLandingTask, DtMoveToLocationTask, DtPlanAndMoveToTask, DtConvoyAlongTask, DtTargetPointTask, DtFireForEffectOnLocationTask, DtLaseTargetTask, DtOrbitTask, DtLaunchExpendableResourceTask, DtStopMovingTask, DtMoveIntoFormationTask, DtScriptedMovementTask, DtTargetEntityTask, DtVerticalLandingTask, DtFireForEffectOnTargetTask, DtMoveToDestinationTask, DtBreachTask, DtFireForEffectOnEntityTask, DtDisembarkAllTask, DtFireAtTargetTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtInternalTransferFuelTask, DtReleaseBombOnLaserSpotTask, DtDisembarkTask, DtLaunchSmokeTask, DtProvideIndirectFireTask, DtReleaseBombOnTargetTask, DtTransferSuppliesTask, DtSendTaskMessageTask, DtCrashIntoTask, DtFireCruiseMissileTask, DtSendSetMessageTask, DtReleaseBombOnLocationTask, DtSendTextTask, DtDiGuyAnimationTask, DtIffInterrogatorSweepTask, DtLaseLocationTask, DtHoldUntilTask, DtFireLaserGuidedMissileTask, DtFlyAltitudeTask, DtIffInterrogatorTask, DtDiGuyGestureTask, DtEmbeddedSetForwardTask, and DtEmbeddedTaskForwardTask.

virtual bool DtSimTask::isTypeRegistered ( const DtSimTaskMessageType &  taskName )

virtual

virtual DtSimTask* DtSimTask::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

pure 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.

Implemented in DtScriptedTaskTask, DtFlyHeadingAndAltitudeTask, DtMoveAlongWithActionsTask, DtMoveAlongRetrogradeTask, DtMoveToRetrogradeTask, DtMoveToLocationRetrogradeTask, DtFlyHeadingTask, DtKeepStationTask, DtFollowEntityTask, DtUserTask, DtRailMoveAlongTask, DtMoveToTask, DtMoveAlongTask, DtWaitElapsedTask, DtRailPathTask, DtRailRouteTask, DtWaitDurationTask, DtPatrolRouteTask, DtPatrolTwoPointsTask, DtFlyAlongTask, DtTurnToHeadingTask, DtDiGuyAnimationTask, DtTakeoffTask, DtWaitTask, DtEmbarkTask, DtMoveToAltitudeTask, DtFlyToLocationTask, DtLandingTask, DtPlanAndMoveToLocationTask, DtConvoyToTask, DtMoveToLocationTask, DtPlanAndMoveToTask, DtConvoyAlongTask, DtTargetPointTask, DtDiGuyGestureTask, DtFireForEffectOnLocationTask, DtLaseTargetTask, DtOrbitTask, DtLaunchExpendableResourceTask, DtStopMovingTask, DtMoveIntoFormationTask, DtScriptedMovementTask, DtTargetEntityTask, DtVerticalLandingTask, DtFireForEffectOnTargetTask, DtMoveToDestinationTask, DtBreachTask, DtFireForEffectOnEntityTask, DtDisembarkAllTask, DtFireAtTargetTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtInternalTransferFuelTask, DtReleaseBombOnLaserSpotTask, DtDisembarkTask, DtLaunchSmokeTask, DtProvideIndirectFireTask, DtReleaseBombOnTargetTask, DtTransferSuppliesTask, DtSendTaskMessageTask, DtCrashIntoTask, DtFireCruiseMissileTask, DtSendSetMessageTask, DtReleaseBombOnLocationTask, DtSendTextTask, DtIffInterrogatorSweepTask, DtLaseLocationTask, DtHoldUntilTask, DtFireLaserGuidedMissileTask, DtIffInterrogatorTask, DtFlyAltitudeTask, DtEmbeddedSetForwardTask, and DtEmbeddedTaskForwardTask.

Referenced by makVrf::DtCreateItemData::DtCreateItemData(), and makVrf::DtCreateItemData::operator=().

virtual DtString DtSimTask::stringRep ( ) const

pure virtual

Returns a human-readable string representation of the task. This string representation is used to display information about the task in the plan editor and viewer. The type and parameters for the task are typically encoded in the string. The format of the string is up to you.

Implemented in DtScriptedTaskTemplate< DtSimTask >, DtFlyHeadingAndAltitudeTask, DtMoveAlongWithActionsTask, DtMoveAlongRetrogradeTask, DtMoveToRetrogradeTask, DtMoveToLocationRetrogradeTask, DtFlyHeadingTask, DtKeepStationTask, DtFollowEntityTask, DtUserTask, DtRailMoveAlongTask, DtMoveToTask, DtMoveAlongTask, DtWaitElapsedTask, DtRailPathTask, DtRailRouteTask, DtWaitDurationTask, DtPatrolRouteTask, DtPatrolTwoPointsTask, DtTakeoffTask, DtFlyAlongTask, DtTurnToHeadingTask, DtEmbarkTask, DtWaitTask, DtLandingTask, DtMoveToAltitudeTask, DtFlyToLocationTask, DtPlanAndMoveToLocationTask, DtConvoyToTask, DtMoveToLocationTask, DtPlanAndMoveToTask, DtConvoyAlongTask, DtSendTaskMessageTask, DtTargetPointTask, DtSendSetMessageTask, DtDiGuyAnimationTask, DtFireForEffectOnLocationTask, DtLaseTargetTask, DtOrbitTask, DtLaunchExpendableResourceTask, DtStopMovingTask, DtMoveIntoFormationTask, DtScriptedMovementTask, DtTargetEntityTask, DtVerticalLandingTask, DtFireForEffectOnTargetTask, DtMoveToDestinationTask, DtBreachTask, DtFireForEffectOnEntityTask, DtDisembarkAllTask, DtFireAtTargetTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtInternalTransferFuelTask, DtReleaseBombOnLaserSpotTask, DtDisembarkTask, DtLaunchSmokeTask, DtProvideIndirectFireTask, DtReleaseBombOnTargetTask, DtTransferSuppliesTask, DtCrashIntoTask, DtFireCruiseMissileTask, DtReleaseBombOnLocationTask, DtSendTextTask, DtDiGuyGestureTask, DtEmbeddedSetForwardTask, DtIffInterrogatorSweepTask, DtLaseLocationTask, DtEmbeddedTaskForwardTask, DtHoldUntilTask, DtFireLaserGuidedMissileTask, DtIffInterrogatorTask, and DtFlyAltitudeTask.

virtual void DtSimTask::setSubtask ( bool  flag )

virtual

If true, this task is a subtask. This will keep taskNotify from clearing the currently executing task, and prevent a request of a new task from the plan manager when this task completes.

virtual bool DtSimTask::subtask ( ) const

virtual

virtual void DtSimTask::setAllowTaskVisualizations ( bool  flag )

virtual

If true, this task is allowed to display its task visualizations. This will keep taskNotify from clearing the currently executing task, and prevent a request of a new task from the plan manager when this task completes.

virtual bool DtSimTask::allowTaskVisualizations ( ) const

virtual

virtual void DtSimTask::putData ( std::string &  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 DtSendTaskMessageTask, DtSendSetMessageTask, DtEmbeddedTaskForwardTask, and DtEmbeddedSetForwardTask.

virtual DtlObjPtr DtSimTask::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 from DtReaderWriter.

Reimplemented in DtSendTaskMessageTask, DtSendSetMessageTask, DtEmbeddedTaskForwardTask, and DtEmbeddedSetForwardTask.

virtual char* DtSimTask::netRep ( )

virtual

virtual int DtSimTask::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class. This is the size in bytes of the DtNetSimTask structure. Derived classes should take into account 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 DtFlyHeadingAndAltitudeTask, DtScriptedTaskTemplate< DtSimTask >, DtMoveAlongWithActionsTask, DtFlyHeadingTask, DtFireForEffectTask, DtMoveToTask, DtKeepStationTask, DtMoveAlongTask, DtRailPathTask, DtUserTask, DtFireCruiseMissileTask, DtFollowEntityTask, DtMoveToLocationTask, DtIffInterrogatorSweepTask, DtRailRouteTask, DtFlyAlongTask, DtRailMoveAlongTask, DtMoveToDestinationTask, DtPatrolTwoPointsTask, DtTakeoffTask, DtEmbarkTask, DtFireAtTargetTask, DtScriptedMovementTask, DtTransferSuppliesTask, DtMoveToAltitudeTask, DtPatrolRouteTask, DtWaitElapsedTask, DtLandingTask, DtTurnToHeadingTask, DtWaitDurationTask, DtBreachTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtOrbitTask, DtConvoyToTask, DtLaunchSmokeTask, DtInternalTransferFuelTask, DtFlyToLocationTask, DtConvoyAlongTask, DtMoveIntoFormationTask, DtWaitTask, DtIffInterrogatorTask, DtLaseTargetTask, DtLaunchExpendableResourceTask, DtTargetPointTask, DtDiGuyAnimationTask, DtFireForEffectOnLocationTask, DtFireForEffectOnTargetTask, DtVerticalLandingTask, DtFireForEffectOnEntityTask, DtSendTaskMessageTask, DtSendTextTask, DtSendSetMessageTask, DtReleaseBombOnTargetTask, DtTargetEntityTask, DtFireLaserGuidedMissileTask, DtFlyAltitudeTask, DtReleaseBombOnLaserSpotTask, DtStopMovingTask, DtCrashIntoTask, DtDiGuyGestureTask, DtReleaseBombOnLocationTask, DtDisembarkAllTask, DtLaseLocationTask, DtDisembarkTask, DtProvideIndirectFireTask, DtReleaseBombTask, DtHoldUntilTask, DtEmbeddedSetForwardTask, and DtEmbeddedTaskForwardTask.

virtual bool DtSimTask::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 in DtFlyHeadingAndAltitudeTask, DtScriptedTaskTemplate< DtSimTask >, DtMoveAlongWithActionsTask, DtFlyHeadingTask, DtFireForEffectTask, DtMoveToTask, DtKeepStationTask, DtMoveAlongTask, DtRailPathTask, DtUserTask, DtFireCruiseMissileTask, DtFollowEntityTask, DtMoveToLocationTask, DtIffInterrogatorSweepTask, DtFlyAlongTask, DtRailRouteTask, DtRailMoveAlongTask, DtMoveToDestinationTask, DtTakeoffTask, DtEmbarkTask, DtPatrolTwoPointsTask, DtFireAtTargetTask, DtScriptedMovementTask, DtTransferSuppliesTask, DtMoveToAltitudeTask, DtLandingTask, DtPatrolRouteTask, DtWaitElapsedTask, DtTurnToHeadingTask, DtWaitDurationTask, DtBreachTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtLaunchSmokeTask, DtOrbitTask, DtConvoyToTask, DtInternalTransferFuelTask, DtFlyToLocationTask, DtConvoyAlongTask, DtMoveIntoFormationTask, DtWaitTask, DtIffInterrogatorTask, DtLaseTargetTask, DtLaunchExpendableResourceTask, DtTargetPointTask, DtFireForEffectOnLocationTask, DtDiGuyAnimationTask, DtFireForEffectOnTargetTask, DtVerticalLandingTask, DtFireForEffectOnEntityTask, DtSendTaskMessageTask, DtSendTextTask, DtSendSetMessageTask, DtReleaseBombOnTargetTask, DtTargetEntityTask, DtFireLaserGuidedMissileTask, DtFlyAltitudeTask, DtReleaseBombOnLaserSpotTask, DtStopMovingTask, DtCrashIntoTask, DtDiGuyGestureTask, DtReleaseBombOnLocationTask, DtDisembarkAllTask, DtLaseLocationTask, DtDisembarkTask, DtProvideIndirectFireTask, DtReleaseBombTask, DtHoldUntilTask, DtEmbeddedSetForwardTask, and DtEmbeddedTaskForwardTask.

virtual bool DtSimTask::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 in DtFlyHeadingAndAltitudeTask, DtScriptedTaskTemplate< DtSimTask >, DtMoveAlongWithActionsTask, DtFlyHeadingTask, DtFireForEffectTask, DtMoveToTask, DtKeepStationTask, DtMoveAlongTask, DtUserTask, DtRailPathTask, DtFireCruiseMissileTask, DtFollowEntityTask, DtFlyAlongTask, DtMoveToLocationTask, DtIffInterrogatorSweepTask, DtRailMoveAlongTask, DtMoveToDestinationTask, DtTakeoffTask, DtEmbarkTask, DtRailRouteTask, DtPatrolTwoPointsTask, DtFireAtTargetTask, DtScriptedMovementTask, DtLandingTask, DtMoveToAltitudeTask, DtTransferSuppliesTask, DtPatrolRouteTask, DtWaitElapsedTask, DtTurnToHeadingTask, DtWaitDurationTask, DtBreachTask, DtFireBallisticGunTask, DtFireMissileLauncherTask, DtLaunchSmokeTask, DtOrbitTask, DtConvoyToTask, DtFlyToLocationTask, DtInternalTransferFuelTask, DtConvoyAlongTask, DtMoveIntoFormationTask, DtWaitTask, DtLaseTargetTask, DtIffInterrogatorTask, DtTargetPointTask, DtFireForEffectOnLocationTask, DtFireForEffectOnTargetTask, DtVerticalLandingTask, DtFireForEffectOnEntityTask, DtLaunchExpendableResourceTask, DtSendTextTask, DtSendTaskMessageTask, DtSendSetMessageTask, DtTargetEntityTask, DtDiGuyAnimationTask, DtReleaseBombOnTargetTask, DtFireLaserGuidedMissileTask, DtFlyAltitudeTask, DtReleaseBombOnLaserSpotTask, DtStopMovingTask, DtCrashIntoTask, DtReleaseBombOnLocationTask, DtDisembarkAllTask, DtLaseLocationTask, DtDiGuyGestureTask, DtDisembarkTask, DtProvideIndirectFireTask, DtReleaseBombTask, DtHoldUntilTask, DtEmbeddedSetForwardTask, and DtEmbeddedTaskForwardTask.

static DtSimTask* DtSimTask::createTask ( DtlObjPtr  mtlStream )

static

Static functions.

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

static DtSimTask* DtSimTask::createTask ( const DtSimTaskMessageType &  taskType )

static

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

static

Adds a task creator member function to the task factory.

static void DtSimTask::setFactory ( DtSimTaskFactory *  factory )

static

static DtSimTaskFactory* DtSimTask::factory ( )

static

virtual char* DtSimTask::createNetworkBuffer ( )

protectedvirtual

Member Data Documentation

DtRwBoolean DtSimTask::mySubtask

protected

DtRwBoolean DtSimTask::myAllowTaskVisualizations

protected

char* DtSimTask::myNetRep

protected

DtSimTaskFactory* DtSimTask::myFactory

staticprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/simTask.h