DtFireForEffectTask is an abstract base class which used to create fire for effect tasks that differ only by target type: entity, location, or target control point. More...

Inheritance diagram for DtFireForEffectTask:

[legend]

Public Member Functions
virtual	~DtFireForEffectTask ()
virtual void	setAmmoTypeName (const DtString &type)
	Set ammo type.
virtual const DtString &	ammoTypeName () const
	Get ammo type.
virtual bool	ammoTypeSpecified () const
	See if ammo type was specified for this task (if not, use default).
virtual void	setNumberOfRounds (int rounds)
virtual int	numberOfRounds () const
virtual bool	numberOfRoundsSpecified () const
virtual void	setDispersionRadius (DtReal radius)
virtual DtReal	dispersionRadius () const
virtual bool	dispersionRadiusSpecified () const
virtual void	setHeightAboveTerrain (DtReal height)
virtual DtReal	heightAboveTerrain () const
virtual bool	heightAboveTerrainSpecified () const
virtual int	netRepSize () const
	Returns the size of the full network representation padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
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 const DtSimTaskMessageType &	type () const =0
	What kind of task am I? Returns a string indicating the kind of task (for example, �move-to�, �follow-entity�).
virtual bool	isTypeRegistered (const DtSimTaskMessageType &taskName)
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
	Make a copy of this task.
virtual DtString	stringRep () const =0
	Returns a human-readable string representation of the task.
virtual void	setSubtask (bool flag)
	If true, this task is a subtask.
virtual bool	subtask () const
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 ()
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
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 bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions
	DtFireForEffectTask ()
	default constructor
	DtFireForEffectTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtFireForEffectTask (const DtString &writeName, const DtFireForEffectTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtFireForEffectTask &	operator= (const DtFireForEffectTask &orig)
	assignment operator
virtual DtString	parameterStringRep () const
	Get a readable string representation of the parameters.
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.
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.

Protected Attributes
DtRwString	myAmmoTypeName
DtRwInt	myNumberOfRounds
DtRwReal	myDispersionRadius
DtRwReal	myHeightAboveTerrain
Protected Attributes inherited from DtSimTask
DtRwBoolean	mySubtask
char *	myNetRep
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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.

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::pair < DtSymbolString, DtString >	DtVariableNameType
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 Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

DtFireForEffectTask is an abstract base class which used to create fire for effect tasks that differ only by target type: entity, location, or target control point.

Constructor & Destructor Documentation

DtFireForEffectTask::DtFireForEffectTask ( )

protected

default constructor

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

protected

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

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

protected

copy constructor

virtual DtFireForEffectTask::~DtFireForEffectTask ( )

virtual

Member Function Documentation

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

protected

assignment operator

virtual void DtFireForEffectTask::setAmmoTypeName ( const DtString & type )

virtual

Set ammo type.

virtual const DtString& DtFireForEffectTask::ammoTypeName ( ) const

virtual

Get ammo type.

virtual bool DtFireForEffectTask::ammoTypeSpecified ( ) const

virtual

See if ammo type was specified for this task (if not, use default).

virtual void DtFireForEffectTask::setNumberOfRounds ( int rounds )

virtual

virtual int DtFireForEffectTask::numberOfRounds ( ) const

virtual

virtual bool DtFireForEffectTask::numberOfRoundsSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setDispersionRadius ( DtReal radius )

virtual

virtual DtReal DtFireForEffectTask::dispersionRadius ( ) const

virtual

virtual bool DtFireForEffectTask::dispersionRadiusSpecified ( ) const

virtual

virtual void DtFireForEffectTask::setHeightAboveTerrain ( DtReal height )

virtual

virtual DtReal DtFireForEffectTask::heightAboveTerrain ( ) const

virtual

virtual bool DtFireForEffectTask::heightAboveTerrainSpecified ( ) const

virtual

virtual int DtFireForEffectTask::netRepSize ( ) const

virtual

Returns the size of the full network representation padded to an 8-byte boundary.

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.

virtual bool DtFireForEffectTask::setToNet ( )

virtual

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

Reimplemented in DtFireForEffectOnEntityTask, DtFireForEffectOnTargetTask, and DtFireForEffectOnLocationTask.

virtual DtString DtFireForEffectTask::parameterStringRep ( ) const

protectedvirtual

Get a readable string representation of the parameters.

Member Data Documentation

DtRwString DtFireForEffectTask::myAmmoTypeName

protected

DtRwInt DtFireForEffectTask::myNumberOfRounds

protected

DtRwReal DtFireForEffectTask::myDispersionRadius

protected

DtRwReal DtFireForEffectTask::myHeightAboveTerrain

protected

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

include/vrftasks/fireForEff.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation