DtSpawnController Class Reference

This controller is part of the traffic spawn system. More...

Inheritance diagram for DtSpawnController:

Public Member Functions
	DtSpawnController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	Constructors, etc.
virtual	~DtSpawnController ()
	destructor
virtual const char *	type () const
	This returns a string from compTypes.h, and identifies the type of component.
const DtString &	templateName () const
	Provide the template name. For backwards compatability only. Use spawnTemplateUUID for new code.
virtual void	registerTaskMsgCallbacks ()
	Register a callback for notification of DtUserTask messages.
virtual void	unregisterTaskMsgCallbacks ()
	Unregister a callback for notification of DtUserTask messages.
virtual bool	init ()
	Calls setRadio()
virtual void	refreshSpawnTemplateData ()
virtual void	preFirstTickInit ()
	Tick.
virtual void	tick ()
	Tick the publisher if the component is on.
Public Member Functions inherited from DtControllerComponent
	DtControllerComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString& name,
virtual	~DtControllerComponent ()
	destructor
virtual DtSimRadio *	radio ()
	The radio this component is listening to.
virtual void	taskNotify (const DtSimTask &task)
	This is used by the entity to notify all controllers that a new task has been received.
virtual void	clearTask ()
	Called when you want to clear out this component's task state.
Public Member Functions inherited from DtSimComponent
	DtSimComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtSimComponent ()
	destructor
void	setParentSystem (DtComponentSystem *system)
	Sets the parent system of this component.
virtual bool	postAddComponentsInit ()
	Called after all components have been created, initialized and added to the component manager.
virtual void	registerAttributeFunctions ()
	Called to register functions that provide system attribute values.
virtual void	postTick ()
	This function is called immediately after tick() is called.
virtual void	timedTick ()
	This version of tick checks to see if the time to tick has arrived.
virtual void	setMinTickPeriod (double minTickPeriod)
	specifies a minimum tick period (which can also be thought of as
virtual double	minTickPeriod () const
	access the minimum tick period
virtual void	setMinTickPeriodVariance (double minTickPeriodVariance)
	set the variance in the minimum tick time
virtual double	minTickPeriodVariance () const
	access the variance in the minimum tick period
virtual void	setNextTickTime (double nextTickTime)
	The next tick time is normally calculated internally.
virtual double	nextTickTime () const
	access the next tick time
virtual double	calculateNextTickTime () const
	The next tick time is equal to mySimManager->exerciseClock()-> approximateElapsedRealTime() + myMinTickPeriod + a random # between -myMinTickPeriodVariance/2.
virtual double	calculateFirstTickTime () const
	Returns the first time value that the component should tick at.
virtual void	setEntity (DtVrfObject *entity)
	The entity's state repository is the place that actuator components make updates and other components look to see our current state.
virtual DtSimComponent *	nextComponent ()
	List management functions.
virtual DtSimComponent *	prevComponent ()
virtual void	setListItem (DtListItem *item)
	Used by DtComponentList.
virtual DtListItem *	listItem ()
virtual void	putData (std::string &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 DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actual stored.
virtual void	addInputPort (DtInputPort *port)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPort (DtInputPort *port)
virtual DtInputPort *	lookupInputPort (const DtString &portName)
	Returns a pointer to the input port registered on this component with the specified name.
virtual DtList	inputPortList () const
	Returns the list of DtInputPorts registered on this component.
virtual void	addOutputPort (DtOutputPort *port)
	Adds this output port to the components output port list so that other components can look it up and attach to it.
virtual void	removeOutputPort (DtOutputPort *port)
virtual DtOutputPort *	lookupOutputPort (const DtString &portName)
	Returns a pointer to the output port registered on this component with the specified name.
virtual DtList	outputPortList () const
	Returns the list of DtOutputPorts registered on this component.
virtual void	addInputPortGroup (DtInputPortGroup *group)
	Adds this input port to the components input port list so that other components can look it up and attach to it.
virtual void	removeInputPortGroup (DtInputPortGroup *group)
virtual DtInputPortGroup *	lookupInputPortGroup (const DtString &groupName)
	Returns a pointer the input port group registered on this component with the specified name.
virtual DtList	inputPortGroupList () const
	Returns the list of DtInputPortGroups registered on this component.
virtual void	addOutputPortGroup (DtOutputPortGroup *group)
	Adds this output port group to the components output port group list so that other components can look it up and attach to it.
virtual void	removeOutputPortGroup (DtOutputPortGroup *group)
virtual DtOutputPortGroup *	lookupOutputPortGroup (const DtString &groupName)
	Returns a pointer the output port group registered on this component with the specified name.
virtual DtList	outputPortGroupList () const
	Returns the list of DtOutputPortGroups registered on this component.
virtual int	priority () const
	Return the current connection priority for this component.
virtual void	setPriority (int priority)
	Sets a new connection priority for this component, and changes all current outgoing connections from this component to the new value.
double	dT () const
	This is the delta-t for this component, which may or may not be the same as the exerciseClock dT.
virtual void	setDT (double deltaT)
	Note that while dT is calculated internally, this makes it possible to 'lie' to the component about dT if necessary.
virtual void	setComponentDescriptor (DtComponentDescriptor *componentDescriptor)
	The component descriptor specified in the order of battle file or parameter file that was used to create this component.
virtual const DtComponentDescriptor *	componentDescriptor () const
virtual bool	tickWhileDestroyed () const
	If the component returns true here, it will be ticked regardless of the destroyed state of the host entity.
DtVrfProcessStateRepositoryManager *	psrManager ()
virtual DtString	componentFullName () const
virtual DtPhysicalWorld *	physicalWorld ()
	Gets the physical world that this component's entity exists in.
virtual const DtPhysicalWorld *	physicalWorld () const
virtual DtAttachedTerrain *	terrainAttachedTo ()
	Gets the terrain that this component's entity is attached to, if any.
virtual const DtAttachedTerrain *	terrainAttachedTo () const
virtual DtVrfObject *	entity ()
	Gets the entity.
virtual const DtVrfObject *	entity () const
virtual DtSimManager *	simManager ()
	Gets the sim manager.
virtual const DtSimManager *	simManager () const
virtual const Coordinate_System *	coordinateSystem () const
	Gets the coordinate system, as it should always exist if the physical world is in a valid state!
virtual Coordinate_System *	coordinateSystem ()
virtual DtVrfObjectStateRepository *	localStateRepository ()
	Gets the local state repository.
virtual const DtVrfObjectStateRepository *	localStateRepository () const
virtual DtTaskVisualizationMap &	taskVisualizations ()
	Returns the list of task visualizations for this component.
virtual bool	taskVisualizationsActive () const
	Returns true if task visualizations are currently active for this component.
virtual void	enable ()
	Is this component enabled or not.
virtual void	disable ()
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 DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
static void	settingConsumerCallback (const DtSettingsObject *settingsObject, void *usr)
	Initialization functions.

Protected Member Functions
virtual void	processSetting (const DtBoolSetting *setting)
virtual DtSpawnControllerPSR *	createPSR ()
virtual void	processRequestSpawnPtDataCallback (const DtVrfObjectMessage *msg)
virtual void	processSetTemplateUUIDCallback (const DtVrfObjectMessage *msg)
virtual void	processObjectRemoved (DtVrfObject *object)
virtual void	embarkIfSpawnAttached (DtVrfObject *)
	If the spawn point is attached embark the supplied object at the spawn point location via the set embarked message with the body offset being the offset of the spawn point from the center of mass of what it is attached to.
virtual std::list< DtVrfObject * >	testAndSinkTraffic ()
	Private utility functions used during the tick.
virtual bool	shouldSinkObject (DtVrfObject *trafficObject, DtVrfObject *sinkPoint)
virtual void	deleteObjects (const std::list< DtVrfObject * > &objectList)
	Deletes the VRF objects contained in this list.
virtual bool	canCreateNow (DtTime timeNow, DtRwSpawnData *spawnData) const
	Determine if the time parameters permit creation now.
virtual DtUUID	findSinkPoint ()
	Select a sink point randomly from the list in the template.
virtual DtTime	nextCreationTime (DtTime timeNow, DtRwSpawnData *spawnData)
	Determine the next entity creation time.
virtual DtVrfObject *	createObject (DtVrfObject *sinkPoint, DtRwSpawnData *spawnData, DtVrfObject *objectToRecycle, bool &dataAvailable)
	Create a new traffic object, or recycle an old one into a new one.
virtual DtVector	creationLocationAndOrientation (double &heading, DtVrfObject *sinkPoint, DtRwSpawnData *spawnData, bool &dataAvailable)
	Finds the creation location and orientation for a new traffic entity.
virtual void	createAndSendDefaultPlan (DtVrfObject *obj, const DtUUID &sinkPoint, DtRwSpawnData *spawnData)
	Gives the spawned entity the default plan (move to sink point and delete self) and sends it to the entity.
virtual double	trafficSpeed (DtRwSpawnData *spawnData)
	Calculates and returns the speed for a new traffic entity.
virtual void	sendEntityPlan (DtVrfObject *entity, const DtPlan &plan)
	Puts the entityPlan in a message and sends it to the spawned entity.
virtual bool	trafficObjectType (DtRwObjectTypeInfo &objType, DtRwSpawnData *spawnData)
	Provides object type to be used to generate a new traffic entity.
void	findClosestRoadSpawnPoints ()
	Find closest points on road network for spawning on roads.
virtual void	processClearTemplates ()
virtual void	processRefreshSpawnTemplateData ()
virtual DtRwSpawnData *	lookupSpawnTemplateData ()
Protected Member Functions inherited from DtControllerComponent
	DtControllerComponent ()
	default constructor
	DtControllerComponent (const DtControllerComponent &orig)
	copy constructor
const DtControllerComponent &	operator= (const DtControllerComponent &orig)
	assignment operator
virtual void	setRadio (DtSimRadio *radio)
Protected Member Functions inherited from DtSimComponent
virtual double	computeCurrentTime ()
	Compute current time and myDT.
bool	testInvariant () const
virtual bool	createPortGroups ()
	Called by init.
virtual bool	createPorts ()
	Called by init.
DtVrfProcessStateRepository *	createComponentPsr (const DtString &defaultPsrType, const DtString &defaultPsrName, bool useDescriptorParams=true)
	Creates a PSR for this component and registers it with the PSR manager.
virtual void	updateTaskVisualizations ()
	Called to update task visualizations after every tick.
virtual void	destroyTaskVisualizations ()
	Destroys all task visualizations for this component.
virtual void	destroyTaskVisualization (const DtString &name)
	Destroys an existing task visualization.
virtual DtPointTaskVisualizationPtr	pointTaskVisualization (const DtString &name)
	Finds an existing or creates a new point task visualization with the given name.
virtual DtLineTaskVisualizationPtr	lineTaskVisualization (const DtString &name)
	Finds an existing or creates a new line task visualization with the given name.
virtual DtAreaTaskVisualizationPtr	areaTaskVisualization (const DtString &name)
	Finds an existing or creates a new area task visualization with the given name.
virtual DtTextTaskVisualizationPtr	textTaskVisualization (const DtString &name)
	Finds an existing or creates a new text task visualization with the given name.
double	calculateNextTaskVisTickTime () const
	Determines the next time the task visualizations should be ticked.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()
Protected Member Functions inherited from DtObjectDebugger< DtSimComponent >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Static Protected Member Functions
static void	requestSpawnPtDataCallback (const DtVrfObjectMessage *msg, void *usr)
	Callback functions for messages.
static void	setTemplateUUIDCallback (const DtVrfObjectMessage *msg, void *usr)
static void	objectRemovedCallback (DtVrfObject *object, void *usr)
static void	clearTemplatesCallback (void *user)
static void	refreshSpawnTemplateDataCallback (void *user)

Protected Attributes
DtSpawnControllerPSR *	myProcessState
const DtSpawnControllerDescriptor *	myTrafficSourceDescriptor
bool	myDrivingOnLeftEnabled
DtReal	mySinkPointRadiusSq
DtPoint	myCachedLocation
bool	myFoundRoadPoints
DtPoint	myClosestRoadPoint
DtPoint	myClosestRoadEdgeA
DtPoint	myClosestRoadEdgeB
bool	myShowRoadDistanceWarning
bool	myDataReady
int	myAwaitingToBeCreated
	Count of number of objects that are pending to be created due to data not being available.
bool	myWarnedOnce
Protected Attributes inherited from DtControllerComponent
DtSimRadio *	myRadio
	Controller components can send messages.
Protected Attributes inherited from DtSimComponent
DtVrfObject *	myEntity
DtVrfObjectStateRepository *	myLocalStateRepository
DtSimManager *	mySimManager
DtComponentSystem *	mySystem
	Pointer to the DtComponentSystem that this component belongs.
DtListItem *	myListItem
DtInputPortMap	myInputPortList
DtOutputPortMap	myOutputPortList
DtInputPortGroupMap	myInputPortGroupList
DtOutputPortGroupMap	myOutputPortGroupList
int	myPriority
double	myMinTickPeriod
double	myMinTickPeriodVariance
double	myNextTickTime
double	myLastTickSimTime
double	myDT
bool	myIsEnabled
	Indicates whether this component should be enabled for ticking or not.
bool	myFirstTick
	Initialized to true in the constructor, set to false by the first call to postTick.
bool	myIsThreadSafe
	Whether this component can be use the DtCriticalSection versions of the tick functions and be ticked in parallel with other components Defaults to false.
const DtComponentDescriptor *	myComponentDescriptor
std::list < DtVrfProcessStateRepository * >	myComponentPsrs
	List of PSRs made using createComponentPsr() that will be deleted by this component when it is destroyed.
bool	myTickEveryFrame
	Flag indicating that tickPeriod is set to 0, and the component will tick every frame.
DtTaskVisualizationMap	myTaskVisualizations
	The visualization objects to be drawn for this component.
double	myNextTaskVisTickTime
	The next tick time for updating the task visualizations.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Private Member Functions
	DtSpawnController ()
	Default constructor; not implemented.
	DtSpawnController (const DtSpawnController &orig)
	copy constructor; not implemented.
const DtSpawnController &	operator= (const DtSpawnController &orig)
	assignment operator; not implemented.

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

Detailed Description

This controller is part of the traffic spawn system.

It creates new entities at a defined interval and gives them a plan to move toward a random sink object. It then monitors these entities, when when they are close to their sink point, it deletes them.

Constructor & Destructor Documentation

DtSpawnController::DtSpawnController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructors, etc.

virtual DtSpawnController::~DtSpawnController ( )

virtual

destructor

DtSpawnController::DtSpawnController ( )

private

Default constructor; not implemented.

DtSpawnController::DtSpawnController ( const DtSpawnController &  orig )

private

copy constructor; not implemented.

Member Function Documentation

virtual const char* DtSpawnController::type ( ) const

virtual

This returns a string from compTypes.h, and identifies the type of component.

Implements DtControllerComponent.

static DtSimComponent* DtSpawnController::creator ( const DtString &  name, DtVrfObject *  owner, DtSimManager *  simManager, DtComponentDescriptor *  desc = 0, DtReaderWriterRegistry *  parentRegistry = 0  )

static

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters

name	Reader writer name of this component.
owner	The DtVrfObject 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).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns

New instance of this class.

const DtString& DtSpawnController::templateName

(

)

const

Provide the template name. For backwards compatability only. Use spawnTemplateUUID for new code.

static void DtSpawnController::settingConsumerCallback ( const DtSettingsObject *  settingsObject, void *  usr  )

static

Initialization functions.

virtual void DtSpawnController::registerTaskMsgCallbacks ( )

virtual

Register a callback for notification of DtUserTask messages.

Overrides this so it can register its interest in DtUserTask* commands

virtual void DtSpawnController::unregisterTaskMsgCallbacks ( )

virtual

Unregister a callback for notification of DtUserTask messages.

This is used if the entity cannot process DtUserTasks

virtual bool DtSpawnController::init ( )

virtual

Calls setRadio()

Reimplemented from DtControllerComponent.

virtual void DtSpawnController::refreshSpawnTemplateData ( )

virtual

virtual void DtSpawnController::processSetting ( const DtBoolSetting *  setting )

protectedvirtual

virtual DtSpawnControllerPSR* DtSpawnController::createPSR ( )

protectedvirtual

static void DtSpawnController::requestSpawnPtDataCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

Callback functions for messages.

virtual void DtSpawnController::processRequestSpawnPtDataCallback ( const DtVrfObjectMessage *  msg )

protectedvirtual

static void DtSpawnController::setTemplateUUIDCallback ( const DtVrfObjectMessage *  msg, void *  usr  )

staticprotected

virtual void DtSpawnController::processSetTemplateUUIDCallback ( const DtVrfObjectMessage *  msg )

protectedvirtual

static void DtSpawnController::objectRemovedCallback ( DtVrfObject *  object, void *  usr  )

staticprotected

virtual void DtSpawnController::processObjectRemoved ( DtVrfObject *  object )

protectedvirtual

virtual void DtSpawnController::embarkIfSpawnAttached ( DtVrfObject *  )

protectedvirtual

If the spawn point is attached embark the supplied object at the spawn point location via the set embarked message with the body offset being the offset of the spawn point from the center of mass of what it is attached to.

virtual void DtSpawnController::preFirstTickInit ( )

virtual

Tick.

The controller must get the pointer to its template at this point; it can't do that in a postScenarioLoad callback function because the spawn-sink manager may not have loaded its templates yet. Also, the init() function is called before postScenarioLoad. See also spawnControllerPSR.h

Reimplemented from DtSimComponent.

virtual void DtSpawnController::tick ( )

virtual

Tick the publisher if the component is on.

Reimplemented from DtSimComponent.

virtual std::list<DtVrfObject*> DtSpawnController::testAndSinkTraffic ( )

protectedvirtual

Private utility functions used during the tick.

Check if any of the traffic objects are near their sink points, and delete them if needed.

virtual bool DtSpawnController::shouldSinkObject ( DtVrfObject *  trafficObject, DtVrfObject *  sinkPoint  )

protectedvirtual

Returns

True if trafficObject has met the sink criteria with regard to the specified sink point.

virtual void DtSpawnController::deleteObjects ( const std::list< DtVrfObject * > &  objectList )

protectedvirtual

Deletes the VRF objects contained in this list.

virtual bool DtSpawnController::canCreateNow ( DtTime  timeNow, DtRwSpawnData *  spawnData  ) const

protectedvirtual

Determine if the time parameters permit creation now.

The standard version checks is-time-based, then compares time with start and end times; also checks is-cyclic, and then cycle-period, duty-cycle, and start-offset to determine if the current time is in an active window. The function also checks to see if the current time is past the PSR->nextCycleStartTime(); if so, it computes the start time of the next burst cycle and updates lastCycleStartTime and nextCycleStartTime. All checks assume that the parameters, and the function argument, are in sim time unless isTimeBased and usesClockTime are true.

virtual DtUUID DtSpawnController::findSinkPoint ( )

protectedvirtual

Select a sink point randomly from the list in the template.

virtual DtTime DtSpawnController::nextCreationTime ( DtTime  timeNow, DtRwSpawnData *  spawnData  )

protectedvirtual

Determine the next entity creation time.

The standard version of this method takes the current time, adds period +- variance% x period.

virtual DtVrfObject* DtSpawnController::createObject ( DtVrfObject *  sinkPoint, DtRwSpawnData *  spawnData, DtVrfObject *  objectToRecycle, bool &  dataAvailable  )

protectedvirtual

Create a new traffic object, or recycle an old one into a new one.

virtual DtVector DtSpawnController::creationLocationAndOrientation ( double &  heading, DtVrfObject *  sinkPoint, DtRwSpawnData *  spawnData, bool &  dataAvailable  )

protectedvirtual

Finds the creation location and orientation for a new traffic entity.

virtual void DtSpawnController::createAndSendDefaultPlan ( DtVrfObject *  obj, const DtUUID &  sinkPoint, DtRwSpawnData *  spawnData  )

protectedvirtual

Gives the spawned entity the default plan (move to sink point and delete self) and sends it to the entity.

virtual double DtSpawnController::trafficSpeed ( DtRwSpawnData *  spawnData )

protectedvirtual

Calculates and returns the speed for a new traffic entity.

This will be a random number between min speed and max speed.

virtual void DtSpawnController::sendEntityPlan ( DtVrfObject *  entity, const DtPlan &  plan  )

protectedvirtual

Puts the entityPlan in a message and sends it to the spawned entity.

virtual bool DtSpawnController::trafficObjectType ( DtRwObjectTypeInfo &  objType, DtRwSpawnData *  spawnData  )

protectedvirtual

Provides object type to be used to generate a new traffic entity.

Will be a random object type from the traffic object type list.

Returns

True if found an object type to use.

void DtSpawnController::findClosestRoadSpawnPoints ( )

protected

Find closest points on road network for spawning on roads.

static void DtSpawnController::clearTemplatesCallback ( void *  user )

staticprotected

virtual void DtSpawnController::processClearTemplates ( )

protectedvirtual

static void DtSpawnController::refreshSpawnTemplateDataCallback ( void *  user )

staticprotected

virtual void DtSpawnController::processRefreshSpawnTemplateData ( )

protectedvirtual

virtual DtRwSpawnData* DtSpawnController::lookupSpawnTemplateData ( )

protectedvirtual

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

private

assignment operator; not implemented.

Member Data Documentation

DtSpawnControllerPSR* DtSpawnController::myProcessState

protected

const DtSpawnControllerDescriptor* DtSpawnController::myTrafficSourceDescriptor

protected

bool DtSpawnController::myDrivingOnLeftEnabled

protected

DtReal DtSpawnController::mySinkPointRadiusSq

protected

DtPoint DtSpawnController::myCachedLocation

protected

bool DtSpawnController::myFoundRoadPoints

protected

DtPoint DtSpawnController::myClosestRoadPoint

protected

DtPoint DtSpawnController::myClosestRoadEdgeA

protected

DtPoint DtSpawnController::myClosestRoadEdgeB

protected

bool DtSpawnController::myShowRoadDistanceWarning

protected

bool DtSpawnController::myDataReady

protected

int DtSpawnController::myAwaitingToBeCreated

protected

Count of number of objects that are pending to be created due to data not being available.

bool DtSpawnController::myWarnedOnce

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmodel/spawnController.h