Public Member Functions |
| | DtRwSpawnData (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) |
| | constructor
|
| | DtRwSpawnData (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) |
| | DtRwSpawnData (const DtRwSpawnData &orig, const DtString &name="temp-spawn-data", DtReaderWriterRegistry *parentRegistry=NULL) |
| | copy constructor
|
| const DtRwSpawnData & | operator= (const DtRwSpawnData &orig) |
| | assignment operator
|
| virtual | ~DtRwSpawnData () |
| | Destructor.
|
| virtual const char * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| virtual DtString | stringRep () const |
| | Produces a print representation of the template data in str.
|
| virtual const DtUUID & | uuid () const |
| | The unique identifier of this spawn template.
|
| void | setUUID (const DtUUID &) |
| | DO NOT CALL. This is only used for archiving/dearchiving purposes from the network.
|
| virtual const DtString & | templateDescription () const |
| | Description of the template.
|
| virtual void | setTemplateDescription (const DtString &desc) |
| virtual const DtString & | overlay () const |
| | The overlay to place the created simulation objects on. Default is Simulation Objects overlay.
|
| virtual void | setOverlay (const DtString &desc) |
|
| virtual const DtString & | templateName () const |
| | Accessors and mutators for the spawn parameter data.
|
| virtual void | setTemplateName (const DtString &name) |
|
| virtual bool | isTimeBased () const |
| | Indicates whether spawning activity is restricted to certain times.
|
| virtual void | setIsTimeBased (bool isTimeBased) |
|
| virtual bool | usesClockTime () const |
| | Indicates whether the start and stop times should be interpreted as clock time (vs.
|
| virtual void | setUsesClockTime (bool isClockTime) |
|
| virtual void | setSpawnStartTime (DtReal t) |
| | The simulation time when spawning starts; in seconds since start time of simulation.
|
| virtual DtReal | spawnStartTime () const |
|
| virtual void | setSpawnEndTime (DtReal t) |
| | The simulation time when spawning ends; in seconds since start time of simulation.
|
| virtual DtReal | spawnEndTime () const |
|
| virtual void | setSpawnPeriod (DtReal t) |
| | The spawn period, in seconds; how much time between spawn events.
|
| virtual DtReal | spawnPeriod () const |
|
| virtual void | setSpawnVariance (DtReal t) |
| | The random variation in spawn time, as a percentage of the spawn period.
|
| virtual DtReal | spawnVariance () const |
|
| virtual bool | isCyclical () const |
| | The flag indicates whether the spawning activity is cyclical, i.e.
|
| virtual void | setIsCyclical (bool isCyclical) |
|
| virtual DtReal | cyclePeriod () const |
| | The period of the cyclical spawning, in seconds.
|
| virtual void | setCyclePeriod (DtReal t) |
|
| virtual DtReal | burstPeriodVariance () const |
| | The variance of the burst cycle period, in percent of the period.
|
| virtual void | setBurstPeriodVariance (DtReal t) |
|
| virtual DtReal | dutyCycle () const |
| | The duty cycle of the spawning cycle, as %.
|
| virtual void | setDutyCycle (DtReal pct) |
|
| virtual DtReal | startOffset () const |
| | The offset from the start of the cycle to the first active time, in seconds.
|
| virtual void | setStartOffset (DtReal t) |
|
| virtual void | setSpawnMaxCount (unsigned t) |
| | Stop spawning if we have this many entities already.
|
| virtual unsigned | spawnMaxCount () const |
|
| virtual void | setSpecifySpeed (bool) |
| | 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.
|
| virtual bool | specifySpeed () const |
|
| virtual void | setSpawnMinSpeed (DtReal t) |
| | Minimum Speed of Spawn Entity In meters/sec.
|
| virtual DtReal | spawnMinSpeed () const |
|
| virtual void | setSpawnMaxSpeed (DtReal t) |
| | Maximum Speed of Spawn Entity In meters/sec.
|
| virtual DtReal | spawnMaxSpeed () const |
|
| virtual void | setSpawnObjectTypes (const DtRwObjectTypeInfoList &t) |
| | Types of objects to spawn.
|
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) |
| | Use Roads?
|
| virtual bool | createOnVectorNetwork () const |
|
| virtual void | setSinkPoints (const DtRwTemplatedUUIDList &t) |
| | The points (names) to use as sinks (move destinations).
|
virtual const
DtRwTemplatedUUIDList & | sinkPoints () const |
| | Was: sinkNodeNames.
|
| virtual DtRwTemplatedUUIDList & | sinkPoints () |
| | Was: sinkNodeNames.
|
| virtual bool | isInSinkList (const DtUUID &) const |
| | Indicates whether this name is in the sink node list.
|
| virtual void | addSinkNode (const DtUUID &) |
| | Adds the sink node to the list.
|
| virtual void | removeSinkNode (const DtUUID &) |
| | Removes the sink node identified by uuid.
|
|
| virtual void | setSpawnPoints (const DtRwTemplatedUUIDList &t) |
| | The points (names) to use as spawn points.
|
virtual const
DtRwTemplatedUUIDList & | spawnPoints () const |
| virtual DtRwTemplatedUUIDList & | spawnPoints () |
| virtual bool | isInSpawnList (const DtUUID &) const |
| | Indicates whether this name is in the spawn points list.
|
| virtual void | addSpawnPoint (const DtUUID &) |
| | Adds the spawn point to the list.
|
| virtual void | removeSpawnPoint (const DtUUID &) |
| | Removes the spawn point identified by uuid.
|
|
| virtual const DtPlan & | entityPlan () const |
| | The plan that the entity will follow.
|
| virtual void | setEntityPlan (const DtPlan &plan) |
| | 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 original 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 * | 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 bool | changedSinceLastChecked () |
| | Returns true if this objects value has changed since the last time this function was called.
|
| virtual bool | peekChangedSinceLastChecked () const |
| | Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
|
| virtual void | putData (std::string &fp, int indentLevel=0) |
| | Deriving class overrides these to get/put class specific data.
|
| 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 &) |
| | Restores 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.
|
Public Member Functions inherited from DtReaderWriter