Public Member Functions |
| | DtChangeWeatherCommand () |
| | default constructor
|
| | DtChangeWeatherCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL) |
| | Usual constructor.
|
| | DtChangeWeatherCommand (const DtString &writeName, const DtChangeWeatherCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL) |
| | copy constructor
|
| virtual | ~DtChangeWeatherCommand () |
| | destructor
|
| DtChangeWeatherCommand & | operator= (const DtChangeWeatherCommand &orig) |
| | assignment operator
|
virtual const
DtSimCommandMessageType & | type () const |
| virtual DtSimCommand * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| virtual int | netRepSize () const |
| | Returns the size in bytes of the network representation of the class.
|
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| | Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).
|
| virtual bool | setToNet () |
| | Calls netRep() to create the network buffer.
|
| virtual DtString | stringRep () const |
| | Text representation of this command.
|
| virtual void | setUUID (const DtUUID &) |
| | The name of the object to set the weather for. If blank will change global weather.
|
| virtual const DtUUID & | uuid () const |
| virtual void | setPriority (int p) |
| | Sets the priority of the weather area. This is unused for global weather.
|
| virtual int | priority () const |
| virtual bool | prioritySpecified () const |
| virtual void | clearPriority () |
| virtual bool | operator== (const DtChangeWeatherCommand &) const |
| virtual bool | operator!= (const DtChangeWeatherCommand &rhs) const |
| virtual void | setAllValuesSpecified (bool) |
| | Sets all values to be specified/not specified.
|
| virtual bool | fromXml (const DtString &s) |
| | Override to set all values specified.
|
| virtual bool | fromXmlFile (const DtFilename &s) |
| | Restores object from given xml file.
|
|
| virtual void | setAirTurbidity (double factor) |
| | The air turbidity.
|
| virtual double | airTurbidity () const |
| virtual bool | airTurbiditySpecified () const |
| | Indicates whether or not the air turbidity is specified in the message.
|
| virtual void | clearAirTurbidity () |
| | Clears the specified flag for air turbidity.
|
|
| virtual void | setAmbientAirTemperature (double factor) |
| | The ambient air temperature.
|
| virtual double | ambientAirTemperature () const |
| virtual bool | ambientAirTemperatureSpecified () const |
| | Indicates whether or not the air turbidity is specified in the message.
|
| virtual void | clearAmbientAirTemperature () |
| | Clears the specified flag for air turbidity.
|
|
| virtual void | setCloudState (DtVrfWeatherCloudState type) |
| | The cloud state.
|
| virtual DtVrfWeatherCloudState | cloudState () const |
| virtual bool | cloudStateSpecified () const |
| | Indicates whether or not the cloud state is specified in the message.
|
| virtual void | clearCloudState () |
| | Clears the specified flag for cloud state.
|
|
| virtual void | setPrecipitationIntensity (double factor) |
| | The precipitation intensity.
|
| virtual double | precipitationIntensity () const |
| virtual bool | precipitationIntensitySpecified () const |
| | Indicates whether or not the precipitation type is specified in the message.
|
| virtual void | clearPrecipitationIntensity () |
| | Clears the specified flag for precipitation intensity.
|
|
| virtual void | setPrecipitationType (DtVrfWeatherPrecipitationType type) |
| | The precipitation type.
|
virtual
DtVrfWeatherPrecipitationType | precipitationType () const |
| virtual bool | precipitationTypeSpecified () const |
| | Indicates whether or not the precipitation type is specified in the message.
|
| virtual void | clearPrecipitationType () |
| | Clears the specified flag for precipitation type.
|
|
| virtual void | setVisibility (double distance) |
| | The visibility distance, specified in meters.
|
| virtual double | visibility () const |
| virtual bool | visibilitySpecified () const |
| | Indicates whether or not the visibility is specified in the message.
|
| virtual void | clearVisibility () |
| | Clears the specified flag for visibility.
|
|
| virtual void | setWindDirection (double radians) |
| | The compass direction from which the wind is blowing, specified in radians.
|
| virtual double | windDirection () const |
| virtual bool | windDirectionSpecified () const |
| | Indicates whether or not the wind direction is specified in the message.
|
| virtual void | clearWindDirection () |
| | Clears the specified flag for wind direction.
|
|
| virtual void | setWindSpeed (double value) |
| | The speed the wind is blowing, specified in meters per second.
|
| virtual double | windSpeed () const |
| virtual bool | windSpeedSpecified () const |
| | Indicates whether or not the wind speed is specified in the message.
|
| virtual void | clearWindSpeed () |
| | Clears the specified flag for wind speed.
|
|
| virtual void | setUnderwaterVisibility (double underwaterVisibility) |
| | Underwater visibility in meters.
|
| virtual double | underwaterVisibility () const |
| virtual bool | underwaterVisibilitySpecified () const |
| | Indicates whether or not the underwater visibility is specified in the message.
|
| virtual void | clearUnderwaterVisibility () |
| | Clears the specified flag for underwater visibility.
|
|
| virtual void | setSurfaceTransparency (double transparency) |
| | Surface transparency (percentage)
|
| virtual double | surfaceTransparency () const |
| virtual bool | surfaceTransparencySpecified () const |
| | Indicates whether or not the underwater visibility is specified in the message.
|
| virtual void | clearSurfaceTransparency () |
| | Clears the specified flag for underwater visibility.
|
|
| virtual void | setWaterCurrentSpeed (double waterCurrentSpeed) |
| | Water velocity in meters per second.
|
| virtual double | waterCurrentSpeed () const |
| virtual bool | waterCurrentSpeedSpecified () const |
| | Indicates whether or not the water velocity is specified in the message.
|
| virtual void | clearWaterCurrentSpeed () |
| | Clears the specified flag for water velocity.
|
|
| virtual void | setWaterCurrentDirection (double waterCurrentDirection) |
| | Water direction in radians clockwise from 0 (north)
|
| virtual double | waterCurrentDirection () const |
| virtual bool | waterCurrentDirectionSpecified () const |
| | Indicates whether or not the visibility is specified in the message.
|
| virtual void | clearWaterCurrentDirection () |
| | Clears the specified flag for visibility.
|
|
| virtual void | setAmbientWaterTemperature (double waterTemperature) |
| | Ambient water temperature in Celsius.
|
| virtual double | ambientWaterTemperature () const |
| virtual bool | ambientWaterTemperatureSpecified () const |
| | Indicates whether or not the ambient water temperature is specified in the message.
|
| virtual void | clearAmbientWaterTemperature () |
| | Clears the specified flag for ambient water temperature.
|
|
| virtual void | setTidalOffset (double tidalOffset) |
| | Tidal offset in meters from the water polygons in the database.
|
| virtual double | tidalOffset () const |
| virtual bool | tidalOffsetSpecified () const |
| | Indicates whether or not the tidal offset is specified in the message.
|
| virtual void | clearTidalOffset () |
| | Clears the specified flag for tidal offset.
|
|
| virtual void | setTidalDirection (bool tidalDirection) |
| | Tidal direction where true represents the tide going in and false represents the tide going out.
|
| virtual bool | tidalDirection () const |
| virtual bool | tidalDirectionSpecified () const |
| | Indicates whether or not the tidal direction is specified in the message.
|
| virtual void | clearTidalDirection () |
| | Clears the specified flag for tidal direction.
|
|
| virtual void | setSwellState (unsigned int state) |
| | Swell state according to the Douglas Sea Scale (integer 0 - 9)
|
| virtual unsigned int | swellState () const |
| virtual bool | swellStateSpecified () const |
| virtual void | clearSwellState () |
|
| virtual void | setSwellStateDirection (double direction) |
| | Swell direction in in radians clockwise from 0 (north)
|
| virtual double | swellStateDirection () const |
| virtual bool | swellStateDirectionSpecified () const |
| virtual void | clearSwellStateDirection () |
|
| virtual void | setSeaState (unsigned int state) |
| | Sea state according to the Douglas Sea Scale (integer 0 - 9)
|
| virtual unsigned int | seaState () const |
| virtual bool | seaStateSpecified () const |
| virtual void | clearSeaState () |
|
| virtual void | setSeaStateDirection (double direction) |
| | Swell direction in in radians clockwise from 0 (north)
|
| virtual double | seaStateDirection () const |
| virtual bool | seaStateDirectionSpecified () const |
| virtual void | clearSeaStateDirection () |
|
| virtual void | setWindDrivenSeaStateEnabled (bool enabled) |
| virtual bool | windDrivenSeaStateEnabled () const |
| virtual bool | windDrivenSeaStateEnabledSpecified () const |
| virtual void | clearWindDrivenSeaStateEnabled () |
|
| virtual void | setChoppiness (double choppiness) |
| | Wave choppiness (0..1)
|
| virtual double | choppiness () const |
| virtual bool | choppinessSpecified () const |
| virtual void | clearChoppiness () |
|
| virtual void | setSurgeDepth (double depth) |
| | Surge depth (meters)
|
| virtual double | surgeDepth () const |
| virtual bool | surgeDepthSpecified () const |
| virtual void | clearSurgeDepth () |
|
| virtual void | setFogHeight (double depth) |
| | Fog height (meters)
|
| virtual double | fogHeight () const |
| virtual bool | fogHeightSpecified () const |
| virtual void | clearFogHeight () |
|
| virtual void | setFogColor (const DtVector &) |
| | Fog color (x = red, y = green, z = blue)
|
| virtual const DtVector & | fogColor () const |
| virtual bool | fogColorSpecified () const |
| virtual void | clearFogColor () |
|
| virtual void | setThermoclineLayer1Depth (double depth) |
| | Thermocline depth (in meters) and permeability (0..1).
|
| virtual double | thermoclineLayer1Depth () const |
| virtual bool | thermoclineLayer1DepthSpecified () const |
| virtual void | clearThermoclineLayer1Depth () |
| virtual void | setThermoclineLayer1Permeability (double depth) |
| virtual double | thermoclineLayer1Permeability () const |
| virtual bool | thermoclineLayer1PermeabilitySpecified () const |
| virtual void | clearThermoclineLayer1Permeability () |
| virtual void | setThermoclineLayer2Depth (double depth) |
| virtual double | thermoclineLayer2Depth () const |
| virtual bool | thermoclineLayer2DepthSpecified () const |
| virtual void | clearThermoclineLayer2Depth () |
| virtual void | setThermoclineLayer2Permeability (double depth) |
| virtual double | thermoclineLayer2Permeability () const |
| virtual bool | thermoclineLayer2PermeabilitySpecified () const |
| virtual void | clearThermoclineLayer2Permeability () |
| virtual void | setThermoclineLayer3Depth (double depth) |
| virtual double | thermoclineLayer3Depth () const |
| virtual bool | thermoclineLayer3DepthSpecified () const |
| virtual void | clearThermoclineLayer3Depth () |
| virtual void | setThermoclineLayer3Permeability (double depth) |
| virtual double | thermoclineLayer3Permeability () const |
| virtual bool | thermoclineLayer3PermeabilitySpecified () const |
| virtual void | clearThermoclineLayer3Permeability () |
| virtual void | setThermoclineLayer4Depth (double depth) |
| virtual double | thermoclineLayer4Depth () const |
| virtual bool | thermoclineLayer4DepthSpecified () const |
| virtual void | clearThermoclineLayer4Depth () |
| virtual void | setThermoclineLayer4Permeability (double depth) |
| virtual double | thermoclineLayer4Permeability () const |
| virtual bool | thermoclineLayer4PermeabilitySpecified () const |
| virtual void | clearThermoclineLayer4Permeability () |
| virtual void | setThermoclineLayer5Depth (double depth) |
| virtual double | thermoclineLayer5Depth () const |
| virtual bool | thermoclineLayer5DepthSpecified () const |
| virtual void | clearThermoclineLayer5Depth () |
| virtual void | setThermoclineLayer5Permeability (double depth) |
| virtual double | thermoclineLayer5Permeability () const |
| virtual bool | thermoclineLayer5PermeabilitySpecified () const |
| virtual void | clearThermoclineLayer5Permeability () |
|
| virtual void | setGeneratedByRemoteWeatherSetter (bool value) |
| | Used internally by VRF.
|
| virtual bool | generatedByRemoteWeatherSetter () const |
 Public Member Functions inherited from DtSimCommand |
| virtual | ~DtSimCommand () |
| | destructor
|
| virtual bool | init () |
| | Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
|
| virtual DtSimCommand * | clone () const |
| | Version of clone that preserves the existing name, and assigns a null parent registry.
|
| virtual void | putData (std::string &fp, int indentLevel=0) |
| | putData writes our type, which is provided by the virtual type accessor of the deriving class.
|
| 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.
|
| virtual char * | netRep () |
| | 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 * | readerWriterType () const |
| | Used to supply a string type that this reader writer type is.
|
| 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 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 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.
|
