Descriptor for DtSpawnController. More...

Inheritance diagram for DtSpawnControllerDescriptor:

Public Member Functions
	DtSpawnControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	real constructor More...

	DtSpawnControllerDescriptor (const DtSpawnControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	All component descriptors must provide a valid copy constructor. More...

DtSpawnControllerDescriptor &	operator= (const DtSpawnControllerDescriptor &orig)
	All component descriptors must provide a valid assignment operator. More...

virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	All component descriptors must provide a valid clone function. More...

virtual	~DtSpawnControllerDescriptor ()
	Destructor. More...

virtual DtString	type () const
	Returns the type of descriptor. More...


virtual void	setSinkPointDeleteRadius (double v)

virtual double	sinkPointDeleteRadius () const


virtual void	setCheckBlockingSpawn (bool v)

virtual bool	checkBlockingSpawn () const


virtual void	setBlockingTypes (const DtRwObjectTypeList &objectTypes)
	Accessor/mutator for myBlockingTypes. More...

virtual DtRwObjectTypeList &	blockingTypes ()

virtual const DtRwObjectTypeList &	blockingTypes () const

Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment More...

virtual	~DtComponentDescriptor ()

virtual void	putData (std::string &fp, int indentLevel=0)
	Overrides base class putData to output our type. More...

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 actually stored. More...

virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary. More...

bool	operator== (const DtComponentDescriptor &) const

	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)

virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with. More...

virtual const DtString &	componentType () const

virtual void	setMinTickPeriod (DtReal minTickPeriod)

virtual DtReal	minTickPeriod () const

virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)

virtual DtReal	minTickPeriodVariance () const

virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime. More...

virtual bool	tickPeriodUsesRealTime () const

virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR. More...

virtual void	setProcessStateRepositoryName (const DtString &name)

virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create. More...

virtual void	setProcessStateRepositoryType (const DtString &type)

virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not. More...

virtual bool	isEnabled () const

virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component. More...

virtual bool	debugActive () const

virtual void	setMinTaskVisualizationTickPeriod (DtReal minTickPeriod)

virtual DtReal	minTaskVisualizationTickPeriod () const

virtual void	setTaskVisualizationsEnabled (bool enabled)

virtual bool	taskVisualizationsEnabled () const

virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not. More...

virtual bool	createComponent () const

virtual void	setCreateOnRemoteObject (bool yesNo)
	Whether or not this component is created on remote versions of the object. More...

virtual bool	createOnRemoteObject () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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

bool	isReadonly () const

virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More...

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values. More...

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

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

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More...

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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

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

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static DtComponentDescriptor *	creator ()
	Creator function to be registered with DtComponentDescriptorFactory. More...

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory. More...

static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e. More...

static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class. More...

static DtComponentDescriptor *	creator ()

static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor. More...

static void	setFactory (DtComponentDescriptorFactory *factory)

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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)
	Given a filename, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Attributes
DtRwReal	mySinkPointDeleteRadius
	Parameter Name: sink-point-delete-radius Parameter The radius around the sink point within which the traffic entities will be deleted. More...

DtRwBoolean	myCheckBlockingSpawn
	Parameter Name: check-blocking-spawn Parameter Whether or not to check if something is blocking an entity from being spawned at a point. More...

DtRwObjectTypeList	myBlockingTypes
	Parameter Name: blocking-types Parameter Description: Types of objects that can block an entity placement. More...

Protected Attributes inherited from DtComponentDescriptor
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component. More...

DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Average tick period for this component. More...

DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: A time range for the tick period. More...

DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the component uses real-time (instead of simulation-time) to determine when it is time to tick. More...

DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component. More...

DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository associated with this component. More...

DtRwBoolean	myIsEnabled
	Parameter Name: is-enabled Parameter Description: Is the component enabled (allowed to tick) or not. More...

DtRwBoolean	myDebug
	This parameter defaults to false. More...

DtRwReal	myMinTaskVisualizationTickPeriod
	Parameter Name: min-task-visualization-tick-period Parameter Description: Average tick period for this component's task visualizations. More...

DtRwBoolean	myTaskVisualizationsEnabled
	Parameter Name: task-visualizations-enabled Parameter Description: Whether this component's task visualizations are enabled. More...

DtRwBoolean	myCreateComponent

DtRwBoolean	myCreateOnRemoteObject
	Parameter Name: create-on-remote-object Parameter Description: If true, this component will be created on remote objects as well as local. More...

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

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

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 Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented More...

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	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

Detailed Description

Descriptor for DtSpawnController.

Constructor & Destructor Documentation

DtSpawnControllerDescriptor::DtSpawnControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

real constructor

DtSpawnControllerDescriptor::DtSpawnControllerDescriptor	(	const DtSpawnControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

All component descriptors must provide a valid copy constructor.

virtual DtSpawnControllerDescriptor::~DtSpawnControllerDescriptor ( )

virtual

Destructor.

Member Function Documentation

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

All component descriptors must provide a valid assignment operator.

virtual DtComponentDescriptor* DtSpawnControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

virtual

All component descriptors must provide a valid clone function.

Reimplemented from DtComponentDescriptor.

virtual DtString DtSpawnControllerDescriptor::type ( ) const

virtual

Returns the type of descriptor.

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtSpawnControllerDescriptor::creator ( )

static

Creator function to be registered with DtComponentDescriptorFactory.

virtual void DtSpawnControllerDescriptor::setSinkPointDeleteRadius ( double v )

virtual

See Also: mySinkPointDeleteRadius

virtual double DtSpawnControllerDescriptor::sinkPointDeleteRadius ( ) const

virtual

virtual void DtSpawnControllerDescriptor::setCheckBlockingSpawn ( bool v )

virtual

See Also: myCheckBlockingSpawn

virtual bool DtSpawnControllerDescriptor::checkBlockingSpawn ( ) const

virtual

virtual void DtSpawnControllerDescriptor::setBlockingTypes ( const DtRwObjectTypeList & objectTypes )

virtual

Accessor/mutator for myBlockingTypes.

virtual DtRwObjectTypeList& DtSpawnControllerDescriptor::blockingTypes ( )

virtual

virtual const DtRwObjectTypeList& DtSpawnControllerDescriptor::blockingTypes ( ) const

virtual

Member Data Documentation

DtRwReal DtSpawnControllerDescriptor::mySinkPointDeleteRadius

protected

Parameter Name: sink-point-delete-radius
Parameter The radius around the sink point within which the traffic entities will be deleted.

Parameter Default Value: 10 meters

DtRwBoolean DtSpawnControllerDescriptor::myCheckBlockingSpawn

protected

Parameter Name: check-blocking-spawn
Parameter Whether or not to check if something is blocking an entity from being spawned at a point.

Hardcoded to check for platforms and humans.

Parameter Default Value: true

DtRwObjectTypeList DtSpawnControllerDescriptor::myBlockingTypes

protected

Parameter Name: blocking-types Parameter Description: Types of objects that can block an entity placement.

Parameter Default Value: Platform and Life form

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjparam/spawnControllerDescriptor.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation