 |
VR-Forces Development_Version Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces Development_Version Class Documentation
|
Public Types | |
| enum | DtMovementDirection { DtForward = 0, DtReverse } |
 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 )() |
Public Member Functions | |
| DtRwRailSegment (const DtString &name="rail-segment", DtReaderWriterRegistry *parentRegistry=NULL) | |
| real constructor | |
| DtRwRailSegment (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwRailSegment (const DtVector &start, const DtVector &end, const DtString &name="rail-segment", DtReaderWriterRegistry *parentRegistry=NULL) | |
| Real constructor from 2 points. | |
| DtRwRailSegment (const DtVector &start, const DtVector &end, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwRailSegment (const DtRailSegment &fromRail, const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwRailSegment (const DtRailSegment &fromRail, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtRwRailSegment (const DtRwRailSegment &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtRwRailSegment & | operator= (const DtRwRailSegment &orig) |
| Assign to DtRwRailSegment. Assigns value only. | |
| DtRwRailSegment & | operator= (const DtRailSegment &orig) |
| virtual | ~DtRwRailSegment () |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. | |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| 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 | 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 (FILE *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. | |
| virtual 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 * | 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 void | putData (FILE *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) |
| Deriving class overrides these to get/put class specific data. | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. | |
| virtual bool | valueSpecified () const |
| The specified flags are used for optional values. | |
| 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) |
| The variable name, if this object is a variable reference. | |
| 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 () |
| The default value to use if the reader/writer object is a variable and that variable is not specified. | |
| 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 () |
| Collection of child DtReaderWriter nodes owned by this object. | |
| 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. | |
| Public Member Functions inherited from DtRailSegment | |
| DtRailSegment () | |
| DtRailSegment (const DtVector &start, const DtVector &end) | |
| virtual | ~DtRailSegment () |
| DtRailSegment (const DtRailSegment &orig) | |
| virtual DtRailSegment * | clone () |
| virtual double | laneCenterOffset (int lane) const |
| virtual std::list< int > | availableLanes () const |
| virtual double | length () const |
| When length is called it will recompute and cache the new length if the endpoints have changed. | |
| virtual void | setStartPoint (const DtVector &start) |
| The first point of the segment. | |
| virtual const DtVector & | startPoint () const |
| The first point of the segment. | |
| virtual void | setEndPoint (const DtVector &end) |
| The last point of the segment. | |
| virtual const DtVector & | endPoint () const |
| The last point of the segment. | |
| virtual void | setSegmentSpeed (double speed) |
| The speed that is recommend along this segment. | |
| virtual double | segmentSpeed () const |
| The speed that is recommend along this segment. | |
| virtual void | setLaneWidth (double width) |
| The lane width of the segment lanes. | |
| virtual double | laneWidth () const |
| The lane width of the segment lanes. | |
| virtual void | setNumberOfLanes (unsigned int lanes) |
| How many lanes are contained in the segment. | |
| virtual unsigned int | numberOfLanes () const |
| How many lanes are contained in the segment. | |
| virtual int | leftLaneOfLane (unsigned lane) const |
| Gets the lane to the left of the lane specified. | |
| virtual int | rightLaneOfLane (unsigned lane) const |
| Gets the lane to the left of the lane specified. | |
| virtual double | findLaneShift (const int fromLane, const int toLane) const |
| This finds the distance between the 2 lanes. | |
| virtual double | laneOffset (int lanePos) const |
| lane offset is the width of all the lanes between the lanePos and the center line Lanes are designated from (number of lanes)/2 -(number of lanes)/2 from the centerline oriented from the segment's start to end point. | |
| virtual void | setIsOneWay (bool way) |
| Directionality of the segment, whether it is one way or not. | |
| virtual bool | isOneWay () const |
| Directionality of the segment, whether it is one way or not. | |
| virtual void | setSpecificationID (const DtSpecificationID id) |
| The specification id of the feature data or route this segment is based from. | |
| virtual const DtSpecificationID | specificationID () const |
| The specification id of the feature data or route this segment is based from. | |
| virtual void | setPathId (const unsigned int id) |
| The path id is a simple way of keeping track of when we turn if we are just at a curve in the path in which case the two connecting segments will have the same id or if an intersection has been reached and the connecting segments will have different path ids. | |
| virtual const unsigned int | pathId () const |
| The path id is a simple way of keeping track of when we turn if we are just at a curve in the path in which case the two connecting segments will have the same id or if an intersection has been reached and the connecting segments will have different path ids. | |
| virtual void | setSegmentSurfaceConditions (DtVrfWeatherPrecipitationType condition) |
| Enviromental Condition of segment. | |
| virtual DtVrfWeatherPrecipitationType | segmentSurfaceConditions () const |
| Enviromental Condition of segment. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (FILE *fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
| static const DtFilename & | appPath () |
| Gets the current working directory. | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &) |
| Given a filename, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromXml (const DtString &) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. | |
| Static Public Member Functions inherited from DtRailSegment | |
| static unsigned int | nextPathId () |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
| 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. | |
| Protected Attributes inherited from DtRailSegment | |
| DtVector | myStartPoint |
| DtVector | myEndPoint |
| double | mySpeed |
| Default is 50 m/s. | |
| double | myLaneWidth |
| Default is 3.66m. This is U.S. Highway standard. | |
| unsigned int | myNumberOfLanes |
| Default is 2 allowing a lane for each direction of traffic. | |
| bool | myIsOneWay |
| Default is false. Allowing traffic in each direction. | |
| unsigned int | myPathId |
| Keep track of if this segment is just a continuation of the current road. | |
| DtSpecificationID | mySpecId |
| Default is 0. It will be set based on whatever feature it was created from. | |
| DtVrfWeatherPrecipitationType | mySurfaceCondition |
| Default is 0–No percipitation. | |
| double | myLength |
| These values are calculated when needed and cached. | |
| bool | myRecomputeLength |
| 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 Protected Attributes inherited from DtRailSegment | |
| static unsigned int | theNextPathId |
| DtRwRailSegment::DtRwRailSegment | ( | const DtString & | name = "rail-segment", |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
real constructor
| DtRwRailSegment::DtRwRailSegment | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtRwRailSegment::DtRwRailSegment | ( | const DtVector & | start, |
| const DtVector & | end, | ||
| const DtString & | name = "rail-segment", |
||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
Real constructor from 2 points.
| DtRwRailSegment::DtRwRailSegment | ( | const DtVector & | start, |
| const DtVector & | end, | ||
| const DtSymbolString & | name, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtRwRailSegment::DtRwRailSegment | ( | const DtRailSegment & | fromRail, |
| const DtString & | name, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtRwRailSegment::DtRwRailSegment | ( | const DtRailSegment & | fromRail, |
| const DtSymbolString & | name, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
| DtRwRailSegment::DtRwRailSegment | ( | const DtRwRailSegment & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
virtual |
| DtRwRailSegment& DtRwRailSegment::operator= | ( | const DtRwRailSegment & | orig | ) |
Assign to DtRwRailSegment. Assigns value only.
| DtRwRailSegment& DtRwRailSegment::operator= | ( | const DtRailSegment & | orig | ) |
Reimplemented from DtRailSegment.
|
virtual |
Top level call to write itself to file.
If write unspecified is true, will write entries that are unspecified, in the format (name <use-default>). Path is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the path is specified with a non-NULL string, then the path prepended to the filename before writing the entry to file.
Reimplemented from DtReaderWriter.
|
virtual |
|
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.