This class implements a controller, which gives the unit the capability to receive supplies. Interacts with units which have the DtResupplySupplierController.

Inheritance diagram for DtResupplyReceiverController:

[legend]

Public Member Functions
	DtResupplyReceiverController (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtResupplyReceiverController ()

virtual const char *	type () const

virtual bool	postAddComponentsInit ()

virtual bool	init ()

virtual void	processSetSupplying (DtSimMessage *msg)

virtual void	addSetDataCallbacks ()

void	removeSetDataCallbacks ()

virtual void	preFirstTickInit ()

virtual void	tick ()

Public Member Functions inherited from DtSingleTaskControllerComponent
	DtSingleTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSingleTaskControllerComponent ()

virtual void	postTick ()

virtual bool	beginProcessingTask (const DtTaskMessage &task, DtSimTaskStatePtr taskState)

virtual void	taskNotify (const DtSimTask &task)

virtual void	taskComplete (bool success=true)

virtual void	clearTask ()

virtual void	suspendTask ()

virtual int	sendSubtask (DtSimTask &task)

virtual void	clearSubtask (int subtaskId)

virtual void	addPendingSubtaskId (int subtaskId)

virtual bool	findPendingSubtaskId (int subtaskId)

virtual bool	isSubtasked () const

virtual void	removePendingSubtaskId (int subtaskId)

virtual void	removeAllPendingSubtaskIds ()

virtual std::vector< int >	currentPendingSubstaskIds () const

virtual void	clearCurrentTaskMessage ()

virtual DtTaskMessage *	currentTaskMessage () const

virtual DtSimTaskStatePtr	currentTaskState () const

virtual bool	decideToGiveUpTask () const

virtual void	giveUpTask ()

virtual bool	taskActive (int taskId) const

virtual bool	clearTopLevelTasks ()

virtual void	clearConflictingTopLevelTasks (const DtSimTaskMessageType &conflictType)

virtual void	clearTasksByType (const DtSimTaskMessageType &taskType)

virtual void	clearTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendTaskById (int taskId)

virtual DtSuspendedTaskInfo *	suspendSubtaskById (int taskId, int subtaskId)

virtual std::list < DtTaskMessage * >	currentTaskMessages () const

virtual DtTaskWithTaskStateListPtr	topLevelTasks () const

virtual void	disable ()

Public Member Functions inherited from DtTaskControllerComponent
	DtTaskControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor compDesc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtTaskControllerComponent ()

virtual bool	showCurrentTaskInGui () const

virtual void	setRadio (DtSimRadio *radio)

virtual void	registerTaskMsgCallbacks ()

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	addTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtMessageCallbackFcn fcn, void *usr)

virtual void	removeTaskProcessorCallback (const DtSimTaskMessageType &taskType, DtTaskMessageCallbackFcn fcn, void *usr)

virtual void	enable ()

virtual void	sendTaskCanceled (DtTaskMessage *taskMsg)

virtual bool	taskVisualizationsActive () const

virtual void	setTasked (bool tasked)

virtual bool	tasked () const

Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtControllerComponent ()

virtual DtSimRadio *	radio ()

virtual void	enableTaskTypes ()

virtual void	disableTaskTypes ()

Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtLocalObject owner, DtSimulationServices simServices, DtComponentDescriptor desc=0, DtReaderWriterRegistry parentRegistry=0)

virtual	~DtSimComponent ()

virtual void	setParentSystem (DtComponentSystem *system)

DtComponentSystem *	parentSystem () const

virtual void	registerAttributeFunctions ()

virtual void	timedTick ()

virtual void	setMinTickPeriod (double minTickPeriod)

virtual double	minTickPeriod () const

virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)

virtual double	minTickPeriodVariance () const

virtual void	setNextTickTime (double nextTickTime)

virtual double	nextTickTime () const

virtual double	calculateNextTickTime () const

virtual double	calculateFirstTickTime () const

virtual void	setEntity (DtLocalObject *entity)

virtual DtSimComponent *	nextComponent ()

virtual DtSimComponent *	prevComponent ()

virtual void	setListItem (DtListItem *item)

virtual DtListItem *	listItem ()

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

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

virtual void	addInputPort (DtInputPort *port)

virtual void	removeInputPort (DtInputPort *port)

virtual DtInputPort *	lookupInputPort (const DtString &portName)

virtual DtList	inputPortList () const

virtual void	addOutputPort (DtOutputPort *port)

virtual void	removeOutputPort (DtOutputPort *port)

virtual DtOutputPort *	lookupOutputPort (const DtString &portName)

virtual DtList	outputPortList () const

virtual void	addInputPortGroup (DtInputPortGroup *group)

virtual void	removeInputPortGroup (DtInputPortGroup *group)

virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)

virtual DtList	inputPortGroupList () const

virtual void	addOutputPortGroup (DtOutputPortGroup *group)

virtual void	removeOutputPortGroup (DtOutputPortGroup *group)

virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)

virtual DtList	outputPortGroupList () const

virtual int	priority () const

virtual void	setPriority (int priority)

double	dT () const

virtual void	setDT (double deltaT)

virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)

virtual const DtComponentDescriptor *	componentDescriptor () const

virtual bool	tickWhileDestroyed () const

DtVrfProcessStateRepositoryManager *	psrManager ()

virtual const DtSymbolString &	componentFullName () const

DtPhysicalWorld *	physicalWorld ()

const DtPhysicalWorld *	physicalWorld () const

const DtAttachedTerrain *	terrainAttachedTo () const

DtLocalObject *	entity ()

const DtLocalObject *	entity () const

DtSimulationServices *	simulationServices ()

const DtSimulationServices *	simulationServices () const

const Coordinate_System *	coordinateSystem () const

virtual bool	taskVisualizationsEnabled () const

makVrf::DtTaskVisualizationMap &	taskVisualizations ()

virtual bool	isEnabled ()

virtual void	setIsEnabled (bool yesNo)

virtual DtOutputStream &	objectConsoleDebug (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleVerbose (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleInfo (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleWarn (const DtString &channel="") const

virtual DtOutputStream &	objectConsoleError (const DtString &channel="") const

virtual int	notifyLevel () const

virtual DtSimResourceManager &	resourceManager ()

virtual const DtSimResourceManager &	resourceManager () const

VRF4API_METHOD const DtSimulationServices *	simManager () const

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 void	setSupplyingCallback (DtSimMessage msg, void usr)

static DtSimComponent *	creator (const DtString &name, DtLocalObject owner, DtSimulationServices simManager, DtComponentDescriptor desc, DtReaderWriterRegistry parentRegistry)

static void	transferSuppliesTaskCallback (DtSimMessage msg, void usr)

Static Public Member Functions inherited from DtTaskControllerComponent
static void	deprecatedTaskProcessorCallbackAdapter (DtSimMessage msg, void usr, DtSimTaskStatePtr taskState)

Static Public Member Functions inherited from DtSimComponent
static DtSimComponentFactory *	factory ()

static void	setFactory (DtSimComponentFactory *factory)

static DtSimComponent *	createComponent (const DtString &name, const DtString &type, DtLocalObject owner, DtSimulationServices simManager, DtComponentSystem parentSystem, DtComponentDescriptor desc=0, DtReaderWriterRegistry *parentRegistry=0)

static void	addSimComponentCreatorFcn (const DtString &type, DtSimComponentCreatorFcn fcn)

static VRF4API_METHOD DtSimComponent *	MarkThreadSafe (DtSimComponent *comp)

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 DtResupplyReceiverControllerPSR *	createPSR ()

virtual const DtResupplyReceiverControllerDescriptor *	getDescriptor ()

virtual void	processTransferSuppliesTask (DtSimMessage *msg)

virtual void	processTransferSuppliesTaskPSR ()

virtual void	retrieveTransferSuppliesTaskParams (const DtTransferSuppliesTask *transferSuppliesTask, DtEntityType &supplyType, double &quantityRequestedTotal, double &rate, DtSimObjectReference &supplier)

virtual void	retrieveTransferSuppliesTaskParamsPSR (const DtTransferSuppliesTask *transferSuppliesTask, std::map< DtString, double > &supplies, std::map< DtString, double > &suppliesRate, DtSimObjectReference &supplier)

virtual bool	verifyTransferSuppliesTaskParams (double amount, double rate)

virtual void	transferSupplies ()

virtual void	processReadyState ()

virtual void	processRequestingState ()

virtual void	processReceivingState ()

virtual void	updateTaskedSupplies (const DtEntityType &supplyType, double quantityRequestedTotal, double rate, DtSimObjectReference supplier)

virtual void	updateTaskedSuppliesPSR (const std::map< DtString, double > &supplies, std::map< DtString, double > &suppliesRate, DtSimObjectReference supplier)

virtual void	updateOfferedSupplies (const makVrfEvents::DtResupplyOfferEvent &resupplyOffer)

virtual void	updateReceivedSupplies (DtTime interval)

virtual void	removeReceivedSupplies ()

virtual bool	checkResourceAvailable (DtEntityType type)

virtual double	resourceAvailable (DtEntityType type)

virtual void	updateResource (DtEntityType type, double quantity)

virtual void	updatePSR ()

virtual const DtString	lookUpSupplyType (const DtEntityType &type) const

virtual const DtEntityType	lookupSupplyName (const DtString &name) const

virtual double	lookupMaxRate (const DtEntityType &type)

virtual double	calculateQuantityRequested (double quantityRequestedTotal)

virtual DtTime	calculateReceivingStateTimeout (double quantityRequestedTotal, double quantityReceivedTotal, double quantityRequested, double quantityOffered, double rate)

virtual DtTime	determineTimer2Period ()

virtual DtTime	currentSimTime ()


virtual void	resupplyOfferEvent (const makVrfEvents::DtEvent &)

virtual void	processResupplyOffer (const makVrfEvents::DtResupplyOfferEvent &resupplyOffer)


virtual void	resupplyCancelEvent (const makVrfEvents::DtEvent &)

virtual void	processResupplyCancel (const makVrfEvents::DtResupplyCancelEvent &resupplyCancel)


virtual makVrfEvents::DtServiceRequestEvent	createServiceRequestInteraction ()

virtual void	sendServiceRequestInteraction (const makVrfEvents::DtServiceRequestEvent &serviceRequest)

virtual makVrfEvents::DtResupplyReceivedEvent	createResupplyReceivedInteraction ()

virtual void	sendResupplyReceivedInteraction (const makVrfEvents::DtResupplyReceivedEvent &resupplyReceived)

virtual makVrfEvents::DtResupplyCancelEvent	createResupplyCancelInteraction ()

virtual void	sendResupplyCancelInteraction (const makVrfEvents::DtResupplyCancelEvent &resupplyCancel)

Protected Member Functions inherited from DtSingleTaskControllerComponent
virtual void	clearPendingSubtasks ()

virtual void	clearSubtasksByType (const DtSimTaskMessageType &taskType)

virtual void	cleanupInactiveSubtaskStatus ()

Protected Member Functions inherited from DtTaskControllerComponent
virtual void	suspendSubtasksOfTask (int taskId, DtSuspendedTaskInfo *suspendInfo)

virtual void	suspendSubtaskOfTask (int taskId, int subtaskId, DtSuspendedTaskInfo *suspendInfo)

virtual DtSimTaskMessageType	remapScriptId (const DtSimTaskMessageType &) const

Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()

	DtControllerComponent (const DtControllerComponent &orig)

const DtControllerComponent &	operator= (const DtControllerComponent &orig)

virtual void	onRestore ()

virtual void	initializeTargetingControlTableFromDescriptor (const DtReaderWriter *)

virtual void	sendCapableSetsAndTasks ()

Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()

bool	testInvariant () const

virtual bool	createPortGroups ()

virtual bool	createPorts ()

DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)

virtual void	updateTaskVisualizations ()

virtual void	destroyTaskVisualizations ()

virtual void	destroyTaskVisualization (const DtString &name)

virtual makVrf::DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)

virtual makVrf::DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)

virtual makVrf::DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)

virtual makVrf::DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)

double	calculateNextTaskVisTickTime () const

DtVrfObjectStateRepository *	localStateRepository ()

const DtVrfObjectStateRepository *	localStateRepository () const

void	addSimObjectPredicateCallback (DtSimObjectReference, DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void *userData=0)

void	removeSimObjectPredicateCallback (const DtSimObject , DtVrfObjectPredicateCallbackFunction function, const DtVrfObjectPredicate &predicate, DtTime evaluationPeriod=0, void userData=0)

void	invokeSimObjectPredicateCallbacks ()

virtual void	clearPredicateCallbacks ()

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

Protected Attributes
DtResupplyReceiverControllerPSR *	myProcessState

const DtResupplyReceiverControllerDescriptor *	myResupplyReceiverDesc

DtResupplyReceiverStateData	myReceiverStateData

const DtTime	theRequestingStateDefaultTimeout = 30.0

const double	theReceivingStateTimeoutPercentage = 0.95

const double	theTotalReceivedAmountCompletePercentage = 0.999

const int	theNumTransferSessions = 10

boost::signals2::scoped_connection	myResupplyOfferEventConnection

boost::signals2::scoped_connection	myResupplyCancelEventConnection

Protected Attributes inherited from DtTaskControllerComponent
DtTaskCallbackMap	myTaskCallbackMap

std::list < DtTaskProcessorCallbackInfo * >	myTaskProcessorCallbackInfoList

bool	myTaskIsRunning

Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio

bool	myTaskTypesEnabled

bool	myInitialized

Protected Attributes inherited from DtSimComponent
DtLocalObject *	myEntity

DtComponentSystem *	mySystem

DtListItem *	myListItem

DtInputPortMap	myInputPortList

DtOutputPortMap	myOutputPortList

DtInputPortGroupMap	myInputPortGroupList

DtOutputPortGroupMap	myOutputPortGroupList

int	myPriority

double	myMinTickPeriod

double	myMinTickPeriodVariance

double	myNextTickTime

double	myLastTickSimTime

double	myDT

bool	myIsEnabled

bool	myFirstTick

const DtComponentDescriptor *	myComponentDescriptor

std::list < DtVrfProcessStateRepository * >	myComponentPsrs

bool	myTickEveryFrame

makVrf::DtTaskVisualizationMap	myTaskVisualizations

double	myNextTaskVisTickTime

DtSymbolString	myFullComponentName

DtSimulationServices *	mySimServices

DtPredicateCallbackManager	myPredicateCallbackManager

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

virtual void	processSupplyListRequest (const DtVrfObjectMessage *msg)

static void	supplyListRequestCallback (const DtVrfObjectMessage msg, void usr)

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

Protected Types inherited from DtTaskControllerComponent
typedef std::pair < DtTaskMessageCallbackFcn, void * >	DtTaskCallbackMapPair

typedef std::map < DtSimTaskMessageType, DtTaskCallbackMapPair >	DtTaskCallbackMap

Protected Types inherited from DtSimComponent
typedef std::map< DtString, DtInputPort * >	DtInputPortMap

typedef std::map< DtString, DtOutputPort * >	DtOutputPortMap

typedef std::map< DtString, DtInputPortGroup * >	DtInputPortGroupMap

typedef std::map< DtString, DtOutputPortGroup * >	DtOutputPortGroupMap

Static Protected Attributes inherited from DtSimComponent
static DtSimComponentFactory *	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

DtResupplyReceiverController::DtResupplyReceiverController	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	compDesc = `0`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

Parameters

name	Reader writer name of this component.
owner	The DtLocalObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

virtual DtResupplyReceiverController::~DtResupplyReceiverController ( )

virtual

destructor

Member Function Documentation

virtual const char* DtResupplyReceiverController::type ( ) const

virtual

Returns a string identifies the class type of component. Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key. Warning: this function should always return the same pointer and it should be valid forever. This means the data should be static.

Implements DtTaskControllerComponent.

virtual bool DtResupplyReceiverController::postAddComponentsInit ( )

virtual

Currently the function does not do anything. It is a placeholder for future use.

Reimplemented from DtControllerComponent.

virtual bool DtResupplyReceiverController::init ( )

virtual

Registers callbacks for PDU messages and Task.

Reimplemented from DtControllerComponent.

static void DtResupplyReceiverController::setSupplyingCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Callback for DtSetSupplyingRequest set data requests. Calls processSetSupplying().

Parameters

msg	Message containing a DtSetSupplyingRequest.
usr	Pointer to an instance of this class.

virtual void DtResupplyReceiverController::processSetSupplying ( DtSimMessage * msg )

virtual

Handler for setSupplyingCallback().

Parameters

msg	Message containing a DtSetSupplyingRequest.

virtual void DtResupplyReceiverController::addSetDataCallbacks ( )

virtual

Add set data request callbacks. Set data request callbacks are added when component is first created, and whenever component is enabled.

void DtResupplyReceiverController::removeSetDataCallbacks ( )

Callbacks are removed when component is disabled or destroyed. Non-virtual because it is called from the destructor.

virtual void DtResupplyReceiverController::preFirstTickInit ( )

virtual

Initialize the component state before it is ticked for the first time. Get the task status from the entity PSR.

Reimplemented from DtSimComponent.

virtual void DtResupplyReceiverController::tick ( )

virtual

tick()

Reimplemented from DtSimComponent.

static DtSimComponent* DtResupplyReceiverController::creator	(	const DtString &	name,
		DtLocalObject *	owner,
		DtSimulationServices *	simManager,
		DtComponentDescriptor *	desc,
		DtReaderWriterRegistry *	parentRegistry
	)

static

static void DtResupplyReceiverController::transferSuppliesTaskCallback	(	DtSimMessage *	msg,
		void *	usr
	)

static

Callback for processing the DtTransferSuppliesTask task.

static void DtResupplyReceiverController::supplyListRequestCallback	(	const DtVrfObjectMessage *	msg,
		void *	usr
	)

static

Responds to weapon list requests with list of weapon names associated with this entity.

virtual void DtResupplyReceiverController::processSupplyListRequest ( const DtVrfObjectMessage * msg )

virtual

Responds to weapon list requests with list of weapon names associated with this entity.

virtual DtResupplyReceiverControllerPSR* DtResupplyReceiverController::createPSR ( )

protectedvirtual

Create the PSR.

virtual const DtResupplyReceiverControllerDescriptor* DtResupplyReceiverController::getDescriptor ( )

protectedvirtual

Gets the descriptor for use in the provider functions.

virtual void DtResupplyReceiverController::resupplyOfferEvent ( const makVrfEvents::DtEvent & )

protectedvirtual

Process Resupply Offer PDU message received from Supplier.

virtual void DtResupplyReceiverController::processResupplyOffer ( const makVrfEvents::DtResupplyOfferEvent & resupplyOffer )

protectedvirtual

Process Resupply Offer PDU message received from Supplier.

virtual void DtResupplyReceiverController::resupplyCancelEvent ( const makVrfEvents::DtEvent & )

protectedvirtual

Process Resupply Cancel PDU message received from Supplier.

virtual void DtResupplyReceiverController::processResupplyCancel ( const makVrfEvents::DtResupplyCancelEvent & resupplyCancel )

protectedvirtual

Process Resupply Cancel PDU message received from Supplier.

virtual makVrfEvents::DtServiceRequestEvent DtResupplyReceiverController::createServiceRequestInteraction ( )

protectedvirtual

Create and send PDU messages to Supplier.

virtual void DtResupplyReceiverController::sendServiceRequestInteraction ( const makVrfEvents::DtServiceRequestEvent & serviceRequest )

protectedvirtual

Send the fully initialized service request interaction.

virtual makVrfEvents::DtResupplyReceivedEvent DtResupplyReceiverController::createResupplyReceivedInteraction ( )

protectedvirtual

Send the fully initialized resupply received interaction.

virtual void DtResupplyReceiverController::sendResupplyReceivedInteraction ( const makVrfEvents::DtResupplyReceivedEvent & resupplyReceived )

protectedvirtual

Create and send PDU messages to Supplier.

virtual makVrfEvents::DtResupplyCancelEvent DtResupplyReceiverController::createResupplyCancelInteraction ( )

protectedvirtual

Create and send PDU messages to Supplier.

virtual void DtResupplyReceiverController::sendResupplyCancelInteraction ( const makVrfEvents::DtResupplyCancelEvent & resupplyCancel )

protectedvirtual

Send the fully initialized resupply cancel interaction.

virtual void DtResupplyReceiverController::processTransferSuppliesTask ( DtSimMessage * msg )

protectedvirtual

virtual void DtResupplyReceiverController::processTransferSuppliesTaskPSR ( )

protectedvirtual

virtual void DtResupplyReceiverController::retrieveTransferSuppliesTaskParams	(	const DtTransferSuppliesTask *	transferSuppliesTask,
		DtEntityType &	supplyType,
		double &	quantityRequestedTotal,
		double &	rate,
		DtSimObjectReference &	supplier
	)

protectedvirtual

retrieve and return the individual task parameters from the DtTransferSuppliesTask

virtual void DtResupplyReceiverController::retrieveTransferSuppliesTaskParamsPSR	(	const DtTransferSuppliesTask *	transferSuppliesTask,
		std::map< DtString, double > &	supplies,
		std::map< DtString, double > &	suppliesRate,
		DtSimObjectReference &	supplier
	)

protectedvirtual

retrieve and return the individual task parameters from the DtTransferSuppliesTask and PSR

virtual bool DtResupplyReceiverController::verifyTransferSuppliesTaskParams	(	double	amount,
		double	rate
	)

protectedvirtual

virtual void DtResupplyReceiverController::transferSupplies ( )

protectedvirtual

virtual void DtResupplyReceiverController::processReadyState ( )

protectedvirtual

virtual void DtResupplyReceiverController::processRequestingState ( )

protectedvirtual

virtual void DtResupplyReceiverController::processReceivingState ( )

protectedvirtual

virtual void DtResupplyReceiverController::updateTaskedSupplies	(	const DtEntityType &	supplyType,
		double	quantityRequestedTotal,
		double	rate,
		DtSimObjectReference	supplier
	)

protectedvirtual

virtual void DtResupplyReceiverController::updateTaskedSuppliesPSR	(	const std::map< DtString, double > &	supplies,
		std::map< DtString, double > &	suppliesRate,
		DtSimObjectReference	supplier
	)

protectedvirtual

virtual void DtResupplyReceiverController::updateOfferedSupplies ( const makVrfEvents::DtResupplyOfferEvent & resupplyOffer )

protectedvirtual

virtual void DtResupplyReceiverController::updateReceivedSupplies ( DtTime interval )

protectedvirtual

virtual void DtResupplyReceiverController::removeReceivedSupplies ( )

protectedvirtual

virtual bool DtResupplyReceiverController::checkResourceAvailable ( DtEntityType type )

protectedvirtual

virtual double DtResupplyReceiverController::resourceAvailable ( DtEntityType type )

protectedvirtual

virtual void DtResupplyReceiverController::updateResource	(	DtEntityType	type,
		double	quantity
	)

protectedvirtual

virtual void DtResupplyReceiverController::updatePSR ( )

protectedvirtual

virtual const DtString DtResupplyReceiverController::lookUpSupplyType ( const DtEntityType & type ) const

protectedvirtual

virtual const DtEntityType DtResupplyReceiverController::lookupSupplyName ( const DtString & name ) const

protectedvirtual

virtual double DtResupplyReceiverController::lookupMaxRate ( const DtEntityType & type )

protectedvirtual

Returns the maximum transfer rate for a particular supply type from the list of supplies.

virtual double DtResupplyReceiverController::calculateQuantityRequested ( double quantityRequestedTotal )

protectedvirtual

virtual DtTime DtResupplyReceiverController::calculateReceivingStateTimeout	(	double	quantityRequestedTotal,
		double	quantityReceivedTotal,
		double	quantityRequested,
		double	quantityOffered,
		double	rate
	)

protectedvirtual

virtual DtTime DtResupplyReceiverController::determineTimer2Period ( )

protectedvirtual

virtual DtTime DtResupplyReceiverController::currentSimTime ( )

protectedvirtual

Member Data Documentation

DtResupplyReceiverControllerPSR* DtResupplyReceiverController::myProcessState

protected

Container for state data associated with this component. This state is saved and restored as part of a scenario (or checkpoint).

const DtResupplyReceiverControllerDescriptor* DtResupplyReceiverController::myResupplyReceiverDesc

protected

Controller descriptor.

DtResupplyReceiverStateData DtResupplyReceiverController::myReceiverStateData

protected

Controller state transition class.

const DtTime DtResupplyReceiverController::theRequestingStateDefaultTimeout = 30.0

protected

The Resupply Receive Timer 1 timeout This is the maximum time to receive a Resupply Offer PDU from the supplier , in response to the Service Request PDU by the receiver.

const double DtResupplyReceiverController::theReceivingStateTimeoutPercentage = 0.95

protected

The actual received supplies should be a portion of the offered So, the calculated time to receive the offered supplies should be reduced The calculated receivingStateTimeout should be multiplied by the bellow theReceivingStateTimeoutPercentage The theReceivingStateTimeoutPercentage value should be less than 1.0 i.e. will receive less than 100% of the offered supplies for the duration of the adjusted receivingStateTimeout.

const double DtResupplyReceiverController::theTotalReceivedAmountCompletePercentage = 0.999

protected

Determines with what precision we decide that we have received what was was requested i.e. - the received amount is close enough to the requested amount - we complete the task.

const int DtResupplyReceiverController::theNumTransferSessions = 10

protected

The number of partial supplies transfers The amount of supplies requested through the task is split into a number of partial transfers with the unit resources being updated after each partial transfer.

boost::signals2::scoped_connection DtResupplyReceiverController::myResupplyOfferEventConnection

protected

boost::signals2::scoped_connection DtResupplyReceiverController::myResupplyCancelEventConnection

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmodel/resupplyReceiverController.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