VR-Link includes. More...

Inheritance diagram for DtReleaseBombOnTargetTask:

Public Member Functions
	DtReleaseBombOnTargetTask ()
	default constructor
	DtReleaseBombOnTargetTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtReleaseBombOnTargetTask (const DtString &writeName, const DtReleaseBombOnTargetTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtReleaseBombOnTargetTask &	operator= (const DtReleaseBombOnTargetTask &orig)
	assignment operator
virtual	~DtReleaseBombOnTargetTask ()
	destructor
virtual const DtSimTaskMessageType &	type () const
	Returns DtReleaseBombOnTargetTaskType as found in taskNames.h.
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
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.

virtual const DtString &	entityName () const
	Get/set target entity name.
virtual void	setEntityName (const DtString &entityName)
	Get/set target entity name.
Public Member Functions inherited from DtReleaseBombTask
virtual	~DtReleaseBombTask ()
	destructor
virtual void	setAmmunitionResourceName (const DtString &type)
	Get/set ammo type.
virtual const DtString &	ammunitionResourceName () const
	Get/set ammo type.
virtual void	setDetonationProximity (DtReal radius)
virtual DtReal	detonationProximity () const
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 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.

Static Public Member Functions
static DtSimTask *	creator ()
	Returns a new instance of this class.

Protected Attributes
DtRwObjectName	myTargetName
Protected Attributes inherited from DtReleaseBombTask
DtRwString	myAmmunitionResourceName
DtRwReal	myDetonationProximity
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
Protected Member Functions inherited from DtReleaseBombTask
	DtReleaseBombTask ()
	default constructor
	DtReleaseBombTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtReleaseBombTask (const DtString &writeName, const DtReleaseBombTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtReleaseBombTask &	operator= (const DtReleaseBombTask &orig)
	assignment operator
virtual DtString	parameterStringRep () const
	Get a readable string representation of the parameters.
Static Protected Attributes inherited from DtSimTask
static DtSimTaskFactory *	myFactory

Detailed Description

VR-Link includes.

A task to release a bomb which is targeted on a named object. It could be any point object - an entity, a waypoint, etc.

Constructor & Destructor Documentation

DtReleaseBombOnTargetTask::DtReleaseBombOnTargetTask ( )

default constructor

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

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

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

copy constructor

virtual DtReleaseBombOnTargetTask::~DtReleaseBombOnTargetTask ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual const DtSimTaskMessageType& DtReleaseBombOnTargetTask::type ( ) const

virtual

Returns DtReleaseBombOnTargetTaskType as found in taskNames.h.

Implements DtSimTask.

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

virtual

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtReleaseBombOnTargetTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtString& DtReleaseBombOnTargetTask::entityName ( ) const

virtual

Get/set target entity name.

virtual void DtReleaseBombOnTargetTask::setEntityName ( const DtString & entityName )

virtual

Get/set target entity name.

virtual int DtReleaseBombOnTargetTask::netRepSize ( ) const

virtual

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

Reimplemented from DtReleaseBombTask.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtReleaseBombTask.

virtual bool DtReleaseBombOnTargetTask::setToNet ( )

virtual

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

Reimplemented from DtReleaseBombTask.

static DtSimTask* DtReleaseBombOnTargetTask::creator ( )

static

Returns a new instance of this class.

Member Data Documentation

DtRwObjectName DtReleaseBombOnTargetTask::myTargetName

protected

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

include/vrftasks/releaseBombOnTargetTask.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation