![]() |
VR-Forces 4.7 Class Documentation
|
DtEmbarkationSlotEntry. More...

Public Member Functions | |
| DtEmbarkationSlotEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| reader-writer constructor | |
| virtual | ~DtEmbarkationSlotEntry () |
| destructor | |
| DtEmbarkationSlotEntry (const DtString &name, const DtEmbarkationSlotEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtEmbarkationSlotEntry (const DtEmbarkationSlotEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor | |
| DtEmbarkationSlotEntry & | operator= (const DtEmbarkationSlotEntry &orig) |
| assignment operator | |
| virtual DtEmbarkationSlotEntry * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. | |
| virtual DtEmbarkationSlotEntry * | clone () const |
| virtual bool | operator== (const DtEmbarkationSlotEntry &) const |
| Equality operators. | |
| virtual bool | operator!= (const DtEmbarkationSlotEntry &) const |
| const DtRangedObjectType & | object () const |
| Accessor/mutator for myObject. | |
| void | setObject (const DtRangedObjectType &) |
| const DtVector & | position () const |
| Accessor/mutator for myPosition. | |
| void | setPosition (const DtVector &) |
| const DtRwTaitBryan | orientation () const |
| Accessor/mutator for myOrientation. | |
| void | setOrientation (const DtTaitBryan &) |
| int | numberOfEntities () const |
| Accessor/mutator for myNumberOfEntities. | |
| void | setNumberOfEntities (int) |
| const DtAppearance & | appearance () const |
| Accessor/mutator for myAppearance. | |
| void | setAppearance (const DtAppearance &) |
| void | setAppearance (int) |
| bool | jumpToLocation () const |
| Accessor/mutator for myJumpToLocation. | |
| void | setJumpToLocation (bool) |
| bool | turnToHeading () const |
| Accessor/mutator for myTurnToHeading. | |
| void | setTurnToHeading (bool) |
| bool | invisibleWhenEmbarked () const |
| Accessor/mutator for myInvisibleWhenEmbarked. | |
| void | setInvisibleWhenEmbarked (bool) |
| const DtString & | slotName () const |
| Accessor/mutator for mySlotName. | |
| void | setSlotName (const DtString &) |
| const DtString & | slotType () const |
| Accessor/mutator for mySlotType. | |
| void | setSlotType (const DtString &) |
| const DtString & | ingressTechnique () const |
| Accessor/mutator for myIngressTechnique. | |
| void | setIngressTechnique (const DtString &) |
| const DtString & | egressTechnique () const |
| Accessor/mutator for myEgressTechnique. | |
| void | setEgressTechnique (const DtString &) |
| const DtString & | animation () const |
| Accessor/mutator for myAnimation. | |
| void | setAnimation (const DtString &) |
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 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 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 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. | |
| 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 | 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 | 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. | |
Protected Attributes | |
parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwRangedObjectType | myObject |
| Parameter Name: embarkable-object Parameter Description: Parameter Default Value: . | |
| DtRwVector | myPosition |
| Parameter Name: embarked-position Parameter Description: Parameter Default Value: . | |
| DtRwTaitBryan | myOrientation |
| Parameter Name: embarked-orientation Parameter Description: Parameter Default Value: . | |
| DtRwAppearance | myAppearance |
| Parameter Name: embarked-appearance Parameter Description: Parameter Default Value: . | |
| DtRwString | myAnimation |
| Parameter Name: animation Parameter Description: The DI-Guy animation to use when embarked. | |
| DtRwInt | myNumberOfEntities |
| Parameter Name: number-of-entities Parameter Description: Number of entities that can occupy this slot -1 means any amount Parameter Default Value: 1 . | |
| DtRwBoolean | myJumpToLocation |
| Parameter Name: jump-to-location Parameter Description: Jump to this location from the end of the ingress or beginning of egress Parameter Default Value: true . | |
| DtRwBoolean | myTurnToHeading |
| Parameter Name: turn-to-heading Parameter Description: Turn to correct heading on start of ingress/egress route or from ingress point to slot or slot to egress point Parameter Default Value: true . | |
| DtRwBoolean | myInvisibleWhenEmbarked |
| Parameter Name: invisible-when-embarked Parameter Description: Whether or not, when embarked, this entity will become invisible to the back-end and front-end Parameter Default Value: false . | |
| DtRwString | mySlotName |
| Parameter Name: slot-name Parameter Description: Free form string that will give the name of this slot. | |
| DtRwString | mySlotType |
| Parameter Name: slot-type Parameter Description: Free for string that defines the type of slot. | |
| DtRwString | myIngressTechnique |
| Parameter Name: ingress-technique Parameter Description: When getting into a slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot Parameter Default Value: . | |
| DtRwString | myEgressTechnique |
| Parameter Name: egress-technique Parameter Description: When getting out of slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot Parameter Default Value: . | |
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. | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. | |
Private Member Functions | |
| DtEmbarkationSlotEntry () | |
| default constructor | |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. | |
| virtual const char * | xmlType () const |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. | |
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 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 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. | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| 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. | |
Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. | |
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 |
Instances of DtEmbarkationSlotEntry are used by the DtOccupancyDirectoryController to determine who can embark on this object and what slots are available.
| DtEmbarkationSlotEntry::DtEmbarkationSlotEntry | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
reader-writer constructor
|
virtual |
destructor
| DtEmbarkationSlotEntry::DtEmbarkationSlotEntry | ( | const DtString & | name, |
| const DtEmbarkationSlotEntry & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
| DtEmbarkationSlotEntry::DtEmbarkationSlotEntry | ( | const DtEmbarkationSlotEntry & | orig, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
copy constructor
|
private |
default constructor
| DtEmbarkationSlotEntry& DtEmbarkationSlotEntry::operator= | ( | const DtEmbarkationSlotEntry & | orig | ) |
assignment operator
|
virtual |
|
inline |
|
inline |
References myObject.
|
inline |
Accessor/mutator for myPosition.
References myPosition.
|
inline |
References myPosition.
|
inline |
Accessor/mutator for myOrientation.
References myOrientation.
|
inline |
References myOrientation.
|
inline |
Accessor/mutator for myNumberOfEntities.
References myNumberOfEntities.
|
inline |
References myNumberOfEntities.
|
inline |
Accessor/mutator for myAppearance.
References myAppearance.
|
inline |
References myAppearance.
|
inline |
References myAppearance.
|
inline |
Accessor/mutator for myJumpToLocation.
References myJumpToLocation.
|
inline |
References myJumpToLocation.
|
inline |
Accessor/mutator for myTurnToHeading.
References myTurnToHeading.
|
inline |
References myTurnToHeading.
|
inline |
Accessor/mutator for myInvisibleWhenEmbarked.
References myInvisibleWhenEmbarked.
|
inline |
References myInvisibleWhenEmbarked.
|
inline |
Accessor/mutator for mySlotName.
References mySlotName.
|
inline |
References mySlotName.
|
inline |
Accessor/mutator for mySlotType.
References mySlotType.
|
inline |
References mySlotType.
|
inline |
Accessor/mutator for myIngressTechnique.
References myIngressTechnique.
|
inline |
References myIngressTechnique.
|
inline |
Accessor/mutator for myEgressTechnique.
References myEgressTechnique.
|
inline |
References myEgressTechnique.
|
inline |
Accessor/mutator for myAnimation.
References myAnimation.
|
inline |
References myAnimation.
|
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 |
|
virtual |
Equality operators.
|
virtual |
|
virtual |
Routines to archive/dearchive from an XML Environment
Reimplemented from DtReaderWriter.
|
virtual |
Gets data from the environment value.
Reimplemented from DtReaderWriter.
|
static |
The type that is used when archiving to an XML stream.
Reimplemented from DtReaderWriter.
|
inlinevirtual |
Reimplemented from DtReaderWriter.
References DtReaderWriter::theXmlType().
|
protected |
Parameter Name: embarkable-object
Parameter Description:
Parameter Default Value:
.
Referenced by object(), and setObject().
|
protected |
Parameter Name: embarked-position
Parameter Description:
Parameter Default Value:
.
Referenced by position(), and setPosition().
|
protected |
Parameter Name: embarked-orientation
Parameter Description:
Parameter Default Value:
.
Referenced by orientation(), and setOrientation().
|
protected |
Parameter Name: embarked-appearance
Parameter Description:
Parameter Default Value:
.
Referenced by appearance(), and setAppearance().
|
protected |
Parameter Name: animation
Parameter Description: The DI-Guy animation to use when embarked.
Only supported on DI-Guy objects.
Parameter Default Value:
Referenced by animation(), and setAnimation().
|
protected |
Parameter Name: number-of-entities
Parameter Description: Number of entities that can occupy this slot
-1 means any amount
Parameter Default Value: 1
.
Referenced by numberOfEntities(), and setNumberOfEntities().
|
protected |
Parameter Name: jump-to-location
Parameter Description: Jump to this location from the end of the
ingress or beginning of egress
Parameter Default Value: true
.
Referenced by jumpToLocation(), and setJumpToLocation().
|
protected |
Parameter Name: turn-to-heading
Parameter Description: Turn to correct heading on start of ingress/egress route
or from ingress point to slot or slot to egress point
Parameter Default Value: true
.
Referenced by setTurnToHeading(), and turnToHeading().
|
protected |
Parameter Name: invisible-when-embarked
Parameter Description: Whether or not, when embarked, this entity will become invisible to the back-end and front-end
Parameter Default Value: false
.
Referenced by invisibleWhenEmbarked(), and setInvisibleWhenEmbarked().
|
protected |
Parameter Name: slot-name
Parameter Description: Free form string that will give the name of this slot.
Should be unique (e.g. Left Front Driver Seat)
Parameter Default Value:
Referenced by setSlotName(), and slotName().
|
protected |
Parameter Name: slot-type
Parameter Description: Free for string that defines the type of slot.
This does not need to be unique (e.g. Passenger)
Parameter Default Value:
Referenced by setSlotType(), and slotType().
|
protected |
Parameter Name: ingress-technique
Parameter Description: When getting into a slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot
Parameter Default Value:
.
Referenced by ingressTechnique(), and setIngressTechnique().
|
protected |
Parameter Name: egress-technique
Parameter Description: When getting out of slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot
Parameter Default Value:
.
Referenced by egressTechnique(), and setEgressTechnique().