Base library for data that is used to control how spawn points generate entities. This data structure has three uses:

Defines the parameters of a spawn point, for a spawn controller to use.
Defines the data in a spawn template, which spawn points initially take their data from.
Defines the data in messages to create and update spawn templates and spawn points. For purposes 1 and 2, this class needs to be a DtReaderWriter so it can be read from and saved to [mtl] scenario files. For reading and writing scenario files, there is also a rw-spawn-template-list class defined in vrfmsgs. For purpose 3, it needs to support encode and decode methods so it can be written to a network message.

Inheritance diagram for DtRwSpawnData:

Public Member Functions
	DtRwSpawnData (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwSpawnData (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)

	DtRwSpawnData (const DtRwSpawnData &orig, const DtString &name="temp-spawn-data", DtReaderWriterRegistry *parentRegistry=NULL)

const DtRwSpawnData &	operator= (const DtRwSpawnData &orig)

virtual	~DtRwSpawnData ()

virtual const char *	readerWriterType () const

virtual DtString	stringRep () const

virtual const DtUUID &	uuid () const

void	setUUID (const DtUUID &)

virtual const DtString &	templateDescription () const

virtual void	setTemplateDescription (const DtString &desc)

virtual const DtString &	overlay () const

virtual void	setOverlay (const DtString &desc)


virtual const DtString &	templateName () const

virtual void	setTemplateName (const DtString &name)


virtual bool	isTimeBased () const

virtual void	setIsTimeBased (bool isTimeBased)


virtual bool	usesClockTime () const

virtual void	setUsesClockTime (bool isClockTime)


virtual void	setSpawnStartTime (DtReal t)

virtual DtReal	spawnStartTime () const


virtual void	setSpawnEndTime (DtReal t)

virtual DtReal	spawnEndTime () const


virtual void	setSpawnPeriod (DtReal t)

virtual DtReal	spawnPeriod () const


virtual void	setSpawnVariance (DtReal t)

virtual DtReal	spawnVariance () const


virtual bool	isCyclical () const

virtual void	setIsCyclical (bool isCyclical)


virtual DtReal	cyclePeriod () const

virtual void	setCyclePeriod (DtReal t)


virtual DtReal	burstPeriodVariance () const

virtual void	setBurstPeriodVariance (DtReal t)


virtual DtReal	dutyCycle () const

virtual void	setDutyCycle (DtReal pct)


virtual DtReal	startOffset () const

virtual void	setStartOffset (DtReal t)


virtual void	setSpawnMaxCount (unsigned t)

virtual unsigned	spawnMaxCount () const


virtual void	setSpecifySpeed (bool)

virtual bool	specifySpeed () const


virtual void	setSpawnMinSpeed (DtReal t)

virtual DtReal	spawnMinSpeed () const


virtual void	setSpawnMaxSpeed (DtReal t)

virtual DtReal	spawnMaxSpeed () const


virtual void	setSpawnObjectTypes (const DtRwObjectTypeInfoList &t)

virtual const DtRwObjectTypeInfoList &	spawnObjectTypes () const

virtual DtRwObjectTypeInfoList &	spawnObjectTypes ()

virtual void	addSpawnObjectType (const DtRwObjectTypeInfo &newType)

virtual void	removeSpawnObjectType (const DtRwObjectType &remType)

virtual void	removeSpawnObjectType (const DtString &name)


virtual void	setCreateOnVectorNetwork (bool t)

virtual bool	createOnVectorNetwork () const


virtual void	setSinkPoints (const DtRwTemplatedUUIDList &t)

virtual const DtRwTemplatedUUIDList &	sinkPoints () const

virtual DtRwTemplatedUUIDList &	sinkPoints ()

virtual bool	isInSinkList (const DtUUID &) const

virtual void	addSinkNode (const DtUUID &)

virtual void	removeSinkNode (const DtUUID &)


virtual void	setSpawnPoints (const DtRwTemplatedUUIDList &t)

virtual const DtRwTemplatedUUIDList &	spawnPoints () const

virtual DtRwTemplatedUUIDList &	spawnPoints ()

virtual bool	isInSpawnList (const DtUUID &) const

virtual void	addSpawnPoint (const DtUUID &)

virtual void	removeSpawnPoint (const DtUUID &)


virtual const DtPlan &	entityPlan () const

virtual void	setEntityPlan (const DtPlan &plan)

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 *	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	putData (std::string &fp, int indentLevel=0)

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

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)

Protected Member Functions
	DtRwSpawnData ()

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

Protected Attributes

DtRwString	mySpawnTemplateName

DtRwUUID	mySpawnTemplateUUID

DtRwString	myDescription

DtRwString	myOverlay

DtRwBoolean	myIsTimeBased

DtRwBoolean	myUsesClockTime

DtRwReal	mySpawnStartTime

DtRwReal	mySpawnEndTime

DtRwReal	mySpawnPeriod

DtRwReal	mySpawnVariance

DtRwBoolean	myIsCyclical

DtRwReal	myCyclePeriod

DtRwReal	myCyclePeriodVariance

DtRwReal	myDutyCycle

DtRwReal	myStartOffset

DtRwUnsigned	mySpawnMaxCount

DtRwReal	mySpawnMinSpeed

DtRwReal	mySpawnMaxSpeed

DtRwObjectTypeInfoList	mySpawnObjectTypes

DtRwBoolean	myCreateOnVectorNetwork

DtRwTemplatedUUIDList	mySinkNodes

DtRwTemplatedUUIDList	mySpawnPoints

DtPlan	myPlan

DtRwBoolean	mySpecifySpeed

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

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

DtRwSpawnData::DtRwSpawnData ( )

protected

Constructors etc.

Default constructor; not implemented.

DtRwSpawnData::DtRwSpawnData	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor

DtRwSpawnData::DtRwSpawnData	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtRwSpawnData::DtRwSpawnData	(	const DtRwSpawnData &	orig,
		const DtString &	name = `"temp-spawn-data"`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtRwSpawnData::~DtRwSpawnData ( )

virtual

Destructor.

Member Function Documentation

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

assignment operator

virtual const char* DtRwSpawnData::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

virtual DtString DtRwSpawnData::stringRep ( ) const

virtual

Produces a print representation of the template data in str.

virtual const DtString& DtRwSpawnData::templateName ( ) const

virtual

Accessors and mutators for the spawn parameter data.

The [short] name of the template. For a point, this is the template that this spawn object should take its parameter values from. If the template name is null, then the parameter values come from the remaining fields in the class.

virtual void DtRwSpawnData::setTemplateName ( const DtString & name )

virtual

Accessors and mutators for the spawn parameter data.

The [short] name of the template. For a point, this is the template that this spawn object should take its parameter values from. If the template name is null, then the parameter values come from the remaining fields in the class.

virtual const DtUUID& DtRwSpawnData::uuid ( ) const

virtual

The unique identifier of this spawn template.

void DtRwSpawnData::setUUID ( const DtUUID & )

DO NOT CALL. This is only used for archiving/dearchiving purposes from the network.

virtual const DtString& DtRwSpawnData::templateDescription ( ) const

virtual

Description of the template. A user can note something about the types of entities this templates spawns, or whatever.

virtual void DtRwSpawnData::setTemplateDescription ( const DtString & desc )

virtual

virtual const DtString& DtRwSpawnData::overlay ( ) const

virtual

The overlay to place the created simulation objects on. Default is Simulation Objects overlay.

virtual void DtRwSpawnData::setOverlay ( const DtString & desc )

virtual

virtual bool DtRwSpawnData::isTimeBased ( ) const

virtual

Indicates whether spawning activity is restricted to certain times.

virtual void DtRwSpawnData::setIsTimeBased ( bool isTimeBased )

virtual

Indicates whether spawning activity is restricted to certain times.

virtual bool DtRwSpawnData::usesClockTime ( ) const

virtual

Indicates whether the start and stop times should be interpreted as clock time (vs. sim time).

virtual void DtRwSpawnData::setUsesClockTime ( bool isClockTime )

virtual

Indicates whether the start and stop times should be interpreted as clock time (vs. sim time).

virtual void DtRwSpawnData::setSpawnStartTime ( DtReal t )

virtual

The simulation time when spawning starts; in seconds since start time of simulation.

virtual DtReal DtRwSpawnData::spawnStartTime ( ) const

virtual

The simulation time when spawning starts; in seconds since start time of simulation.

virtual void DtRwSpawnData::setSpawnEndTime ( DtReal t )

virtual

The simulation time when spawning ends; in seconds since start time of simulation.

virtual DtReal DtRwSpawnData::spawnEndTime ( ) const

virtual

The simulation time when spawning ends; in seconds since start time of simulation.

virtual void DtRwSpawnData::setSpawnPeriod ( DtReal t )

virtual

The spawn period, in seconds; how much time between spawn events.

virtual DtReal DtRwSpawnData::spawnPeriod ( ) const

virtual

The spawn period, in seconds; how much time between spawn events.

virtual void DtRwSpawnData::setSpawnVariance ( DtReal t )

virtual

The random variation in spawn time, as a percentage of the spawn period. I.e., for a spawn period of 6 seconds: a variance of 100 means that the time between spawns varies uniformly between 0 and 12 seconds; a variance of 50 means that the time between spawns varies uniformly between 3 and 9 seconds.

virtual DtReal DtRwSpawnData::spawnVariance ( ) const

virtual

The random variation in spawn time, as a percentage of the spawn period. I.e., for a spawn period of 6 seconds: a variance of 100 means that the time between spawns varies uniformly between 0 and 12 seconds; a variance of 50 means that the time between spawns varies uniformly between 3 and 9 seconds.

virtual bool DtRwSpawnData::isCyclical ( ) const

virtual

The flag indicates whether the spawning activity is cyclical, i.e. has bursts with periods of inactivity between bursts. If not, activity is continuous.

Indicates that spawn activity is cyclical.

virtual void DtRwSpawnData::setIsCyclical ( bool isCyclical )

virtual

The flag indicates whether the spawning activity is cyclical, i.e. has bursts with periods of inactivity between bursts. If not, activity is continuous.

Indicates that spawn activity is cyclical.

virtual DtReal DtRwSpawnData::cyclePeriod ( ) const

virtual

The period of the cyclical spawning, in seconds.

virtual void DtRwSpawnData::setCyclePeriod ( DtReal t )

virtual

The period of the cyclical spawning, in seconds.

virtual DtReal DtRwSpawnData::burstPeriodVariance ( ) const

virtual

The variance of the burst cycle period, in percent of the period. I.e., for a cycle period of 6 minutes: a variance of 100 means that the time between bursts varies uniformly between 0 and 12 minutes; a variance of 50 means that the time between bursts varies uniformly between 3 and 9 minutes.

virtual void DtRwSpawnData::setBurstPeriodVariance ( DtReal t )

virtual

The variance of the burst cycle period, in percent of the period. I.e., for a cycle period of 6 minutes: a variance of 100 means that the time between bursts varies uniformly between 0 and 12 minutes; a variance of 50 means that the time between bursts varies uniformly between 3 and 9 minutes.

virtual DtReal DtRwSpawnData::dutyCycle ( ) const

virtual

The duty cycle of the spawning cycle, as %. I.e. period of 60 seconds, duty cycle of 20 means that spawning happens for 12 seconds and then no spawning occurs for 48 seconds, and then the cycle is repeated.

virtual void DtRwSpawnData::setDutyCycle ( DtReal pct )

virtual

The duty cycle of the spawning cycle, as %. I.e. period of 60 seconds, duty cycle of 20 means that spawning happens for 12 seconds and then no spawning occurs for 48 seconds, and then the cycle is repeated.

virtual DtReal DtRwSpawnData::startOffset ( ) const

virtual

The offset from the start of the cycle to the first active time, in seconds. In the example above, an offset of 15 means from the start time, there is no spawning for 15 seconds, then spawning occurs for 12 seconds, then none for 48 seconds, etc.

virtual void DtRwSpawnData::setStartOffset ( DtReal t )

virtual

The offset from the start of the cycle to the first active time, in seconds. In the example above, an offset of 15 means from the start time, there is no spawning for 15 seconds, then spawning occurs for 12 seconds, then none for 48 seconds, etc.

virtual void DtRwSpawnData::setSpawnMaxCount ( unsigned t )

virtual

Stop spawning if we have this many entities already.

virtual unsigned DtRwSpawnData::spawnMaxCount ( ) const

virtual

Stop spawning if we have this many entities already.

virtual void DtRwSpawnData::setSpecifySpeed ( bool )

virtual

Sets whether or not to use the default speed, or the specified min/max speed If default speed is used all entities will be spawned at their default minimum speed. Default is false.

virtual bool DtRwSpawnData::specifySpeed ( ) const

virtual

Sets whether or not to use the default speed, or the specified min/max speed If default speed is used all entities will be spawned at their default minimum speed. Default is false.

virtual void DtRwSpawnData::setSpawnMinSpeed ( DtReal t )

virtual

Minimum Speed of Spawn Entity In meters/sec.

virtual DtReal DtRwSpawnData::spawnMinSpeed ( ) const

virtual

Minimum Speed of Spawn Entity In meters/sec.

virtual void DtRwSpawnData::setSpawnMaxSpeed ( DtReal t )

virtual

Maximum Speed of Spawn Entity In meters/sec.

virtual DtReal DtRwSpawnData::spawnMaxSpeed ( ) const

virtual

Maximum Speed of Spawn Entity In meters/sec.

virtual void DtRwSpawnData::setSpawnObjectTypes ( const DtRwObjectTypeInfoList & t )

virtual

Types of objects to spawn.

virtual const DtRwObjectTypeInfoList& DtRwSpawnData::spawnObjectTypes ( ) const

virtual

Types of objects to spawn.

virtual DtRwObjectTypeInfoList& DtRwSpawnData::spawnObjectTypes ( )

virtual

Types of objects to spawn.

virtual void DtRwSpawnData::addSpawnObjectType ( const DtRwObjectTypeInfo & newType )

virtual

Types of objects to spawn.

virtual void DtRwSpawnData::removeSpawnObjectType ( const DtRwObjectType & remType )

virtual

Types of objects to spawn.

virtual void DtRwSpawnData::removeSpawnObjectType ( const DtString & name )

virtual

Types of objects to spawn.

virtual void DtRwSpawnData::setCreateOnVectorNetwork ( bool t )

virtual

Use Roads?

virtual bool DtRwSpawnData::createOnVectorNetwork ( ) const

virtual

Use Roads?

virtual void DtRwSpawnData::setSinkPoints ( const DtRwTemplatedUUIDList & t )

virtual

The points (names) to use as sinks (move destinations).Was: setSinkNodeNames.

virtual const DtRwTemplatedUUIDList& DtRwSpawnData::sinkPoints ( ) const

virtual

Was: sinkNodeNames.

virtual DtRwTemplatedUUIDList& DtRwSpawnData::sinkPoints ( )

virtual

Was: sinkNodeNames.

virtual bool DtRwSpawnData::isInSinkList ( const DtUUID & ) const

virtual

Indicates whether this name is in the sink node list.

virtual void DtRwSpawnData::addSinkNode ( const DtUUID & )

virtual

Adds the sink node to the list. Makes a copy of the argument before adding.

virtual void DtRwSpawnData::removeSinkNode ( const DtUUID & )

virtual

Removes the sink node identified by uuid.

virtual void DtRwSpawnData::setSpawnPoints ( const DtRwTemplatedUUIDList & t )

virtual

The points (names) to use as spawn points.

virtual const DtRwTemplatedUUIDList& DtRwSpawnData::spawnPoints ( ) const

virtual

The points (names) to use as spawn points.

virtual DtRwTemplatedUUIDList& DtRwSpawnData::spawnPoints ( )

virtual

The points (names) to use as spawn points.

virtual bool DtRwSpawnData::isInSpawnList ( const DtUUID & ) const

virtual

Indicates whether this name is in the spawn points list.

virtual void DtRwSpawnData::addSpawnPoint ( const DtUUID & )

virtual

Adds the spawn point to the list. Makes a copy of the argument before adding.

virtual void DtRwSpawnData::removeSpawnPoint ( const DtUUID & )

virtual

Removes the spawn point identified by uuid.

virtual const DtPlan& DtRwSpawnData::entityPlan ( ) const

virtual

  The plan that the entity will follow.

If this plan is empty, a hard-coded default plan will be used instead (which is to move to a sink point and delete self).

virtual void DtRwSpawnData::setEntityPlan ( const DtPlan & plan )

virtual

  The plan that the entity will follow.

If this plan is empty, a hard-coded default plan will be used instead (which is to move to a sink point and delete self).