DtTransferSuppliesTask Class Reference

VR-Link includes.

A task to transfer supplies from one entity to another. It gets assigned to the DtResupplyReceiverController

Inheritance diagram for DtTransferSuppliesTask:

Public Member Functions
	DtTransferSuppliesTask ()
	DtTransferSuppliesTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtTransferSuppliesTask (const DtString &writeName, const DtTransferSuppliesTask &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtTransferSuppliesTask &	operator= (const DtTransferSuppliesTask &orig)
virtual	~DtTransferSuppliesTask ()
virtual const DtSimTaskMessageType &	type () const
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	stringRep () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual const DtEntityType &	supplyType () const
virtual void	setSupplyType (const DtEntityType &type)
virtual const double	amount () const
virtual void	setAmount (const double amount)
virtual const bool	maxAmount () const
virtual void	setMaxAmount (const bool maxAmount)
virtual const double	rate () const
virtual void	setRate (const double rate)
virtual const DtUUID &	supplier () const
virtual void	setSupplier (const DtUUID &)
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 void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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	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 DtString	parameterStringRep () const
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
parameters
These parameters are available for setting as a list in the DtTransferSuppliesTask.
DtRwEntityType	mySupplyType
DtRwReal	myAmount
DtRwBoolean	myMaxAmount
DtRwReal	myRate
DtRwUUID	mySupplier
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

DtTransferSuppliesTask::DtTransferSuppliesTask

(

)

default constructor

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

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

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

copy constructor

virtual DtTransferSuppliesTask::~DtTransferSuppliesTask ( )

virtual

destructor

Member Function Documentation

const DtTransferSuppliesTask& DtTransferSuppliesTask::operator=

(

const DtTransferSuppliesTask &

orig

)

assignment operator

virtual const DtSimTaskMessageType& DtTransferSuppliesTask::type ( ) const

virtual

Returns DtTransferSuppliesTaskType as found in taskNames.h.

Implements DtSimTask.

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

virtual

Creates a copy of this task.

Implements DtSimTask.

virtual DtString DtTransferSuppliesTask::stringRep ( ) const

virtual

Get a readable string representation of this task.

Implements DtSimTask.

virtual const DtEntityType& DtTransferSuppliesTask::supplyType ( ) const

virtual

Accessor/mutator for supply type.

virtual void DtTransferSuppliesTask::setSupplyType ( const DtEntityType &  type )

virtual

Accessor/mutator for supply type.

virtual const double DtTransferSuppliesTask::amount ( ) const

virtual

Accessor/mutator for supply amount.

virtual void DtTransferSuppliesTask::setAmount ( const double  amount )

virtual

Accessor/mutator for supply amount.

virtual const bool DtTransferSuppliesTask::maxAmount ( ) const

virtual

Accessor/mutator for max-amount.

virtual void DtTransferSuppliesTask::setMaxAmount ( const bool  maxAmount )

virtual

Accessor/mutator for max-amount.

virtual const double DtTransferSuppliesTask::rate ( ) const

virtual

Accessor/mutator for transfer rate.

virtual void DtTransferSuppliesTask::setRate ( const double  rate )

virtual

Accessor/mutator for transfer rate.

virtual const DtUUID& DtTransferSuppliesTask::supplier ( ) const

virtual

Accessor/mutator for supplier entity.

virtual void DtTransferSuppliesTask::setSupplier ( const DtUUID &  )

virtual

Accessor/mutator for supplier entity.

virtual int DtTransferSuppliesTask::netRepSize ( ) const

virtual

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

Reimplemented from DtSimTask.

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

virtual

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtTransferSuppliesTask::setToNet ( )

virtual

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

Reimplemented from DtSimTask.

static DtSimTask* DtTransferSuppliesTask::creator ( )

static

Returns a new instance of this class.

virtual DtString DtTransferSuppliesTask::parameterStringRep ( ) const

protectedvirtual

Get a readable string representation of the parameters.

Member Data Documentation

DtRwEntityType DtTransferSuppliesTask::mySupplyType

protected

Parameter Name: supply-type
Parameter Description: DIS/RPR entity type enumeration representing the kind of supply that can be transferred.
.

DtRwReal DtTransferSuppliesTask::myAmount

protected

Parameter Name: amount
Parameter Description: The supply amount to be transferred.
.

DtRwBoolean DtTransferSuppliesTask::myMaxAmount

protected

Parameter Name: max-amount
Parameter Description: Flag to indicate that the maximum supply amount should be transferred - i.e. fill up.
.

DtRwReal DtTransferSuppliesTask::myRate

protected

Parameter Name: rate
Parameter Description: The rate at which the supply should be transferred.
.

DtRwUUID DtTransferSuppliesTask::mySupplier

protected

Parameter Name: supplier
Parameter Description: The entity providing the supplies to be transferred.
.

---

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

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