VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions
DtChangeGlobalWeatherCommand Class Reference

A DtSimCommand subclass which specifies a change to the global weather settings in the simulation engine. More...

Inheritance diagram for DtChangeGlobalWeatherCommand:
Inheritance graph
[legend]

Public Member Functions

 DtChangeGlobalWeatherCommand ()
 default constructor More...
 
 DtChangeGlobalWeatherCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
 Usual constructor. More...
 
 DtChangeGlobalWeatherCommand (const DtString &writeName, const DtChangeGlobalWeatherCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
virtual ~DtChangeGlobalWeatherCommand ()
 destructor More...
 
DtChangeGlobalWeatherCommandoperator= (const DtChangeGlobalWeatherCommand &orig)
 assignment operator More...
 
virtual const
DtSimCommandMessageType
type () const
 
virtual DtSimCommandclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
 
- Public Member Functions inherited from DtChangeWeatherCommand
 DtChangeWeatherCommand ()
 default constructor More...
 
 DtChangeWeatherCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
 Usual constructor. More...
 
 DtChangeWeatherCommand (const DtString &writeName, const DtChangeWeatherCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor More...
 
virtual ~DtChangeWeatherCommand ()
 destructor More...
 
DtChangeWeatherCommandoperator= (const DtChangeWeatherCommand &orig)
 assignment operator More...
 
virtual int netRepSize () const
 Returns the size in bytes of the network representation of the class. More...
 
virtual bool setFromNet (const char *contentBuffer, unsigned contentSize)
 Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand). More...
 
virtual bool setToNet ()
 Calls netRep() to create the network buffer. More...
 
virtual DtString stringRep () const
 Text representation of this command. More...
 
virtual void setUUID (const DtUUID &)
 The name of the object to set the weather for. If blank will change global weather. More...
 
virtual const DtUUIDuuid () const
 
virtual void setPriority (int p)
 Sets the priority of the weather area. This is unused for global weather. More...
 
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. More...
 
virtual bool fromXml (const DtString &s)
 Override to set all values specified. More...
 
virtual bool fromXmlFile (const DtFilename &s)
 Restores object from given xml file. More...
 
virtual void getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 Override to load old wind speed, visibility and wind direction at altitude 0 values. More...
 
virtual void setAirTurbidity (double factor)
 The air turbidity. More...
 
virtual double airTurbidity () const
 
virtual bool airTurbiditySpecified () const
 Indicates whether or not the air turbidity is specified in the message. More...
 
virtual void clearAirTurbidity ()
 Clears the specified flag for air turbidity. More...
 
virtual void setAmbientAirTemperature (double celsius)
 The ambient air temperature in degrees celsius. More...
 
virtual double ambientAirTemperature () const
 
virtual bool ambientAirTemperatureSpecified () const
 Indicates whether or not the air temperature is specified in the message. More...
 
virtual void clearAmbientAirTemperature ()
 Clears the specified flag for air temperature. More...
 
virtual void setAmbientAirPressure (double factor)
 The ambient air pressure in kilo pascals. More...
 
virtual double ambientAirPressure () const
 
virtual bool ambientAirPressureSpecified () const
 Indicates whether or not the air pressure is specified in the message. More...
 
virtual void clearAmbientAirPressure ()
 Clears the specified flag for air pressure. More...
 
virtual void setAirPressureAltitude (double factor)
 The air pressure altitude in meters. More...
 
virtual double airPressureAltitude () const
 
virtual bool airPressureAltitudeSpecified () const
 Indicates whether or not the air pressure altitude is specified in the message. More...
 
virtual void clearAirPressureAltitude ()
 Clears the specified flag for air pressure altitude. More...
 
virtual void setAirTemperatureAltitude (double factor)
 The air temperature altitude in meters. More...
 
virtual double airTemperatureAltitude () const
 
virtual bool airTemperatureAltitudeSpecified () const
 Indicates whether or not the air temperature altitude is specified in the message. More...
 
virtual void clearAirTemperatureAltitude ()
 Clears the specified flag for air temperature altitude. More...
 
virtual void setAirPressureAltitudeIsSeaLevel (bool seaLevel)
 The air pressure altitude is sea level flag. More...
 
virtual bool airPressureAltitudeIsSeaLevel () const
 
virtual bool airPressureAltitudeIsSeaLevelSpecified () const
 Indicates whether or not the air pressure altitude is sea level flag is specified in the message. More...
 
virtual void clearAirPressureAltitudeIsSeaLevel ()
 Clears the specified flag for air pressure altitude is sea level flag. More...
 
virtual void setAirTemperatureAltitudeIsSeaLevel (bool seaLevel)
 The air temperature altitude is sea level flag. More...
 
virtual bool airTemperatureAltitudeIsSeaLevel () const
 
virtual bool airTemperatureAltitudeIsSeaLevelSpecified () const
 Indicates whether or not the air temperature altitude is sea level flag is specified in the message. More...
 
virtual void clearAirTemperatureAltitudeIsSeaLevel ()
 Clears the specified flag for air temperature altitude is sea level flag. More...
 
virtual void setSeaLevelWaterConcentration (double factor)
 The sea level water concentration in PPMV (parts per million by volume) More...
 
virtual double seaLevelWaterConcentration () const
 
virtual bool seaLevelWaterConcentrationSpecified () const
 Indicates whether or not the sea level water concentration is specified in the message. More...
 
virtual void clearSeaLevelWaterConcentration ()
 Clears the specified flag for sea level water concentration . More...
 
virtual void setPrecipitationIntensity (double factor)
 The precipitation intensity. More...
 
virtual double precipitationIntensity () const
 
virtual bool precipitationIntensitySpecified () const
 Indicates whether or not the precipitation type is specified in the message. More...
 
virtual void clearPrecipitationIntensity ()
 Clears the specified flag for precipitation intensity. More...
 
virtual void setPrecipitationType (DtVrfWeatherPrecipitationType type)
 The precipitation type. More...
 
virtual
DtVrfWeatherPrecipitationType 
precipitationType () const
 
virtual bool precipitationTypeSpecified () const
 Indicates whether or not the precipitation type is specified in the message. More...
 
virtual void clearPrecipitationType ()
 Clears the specified flag for precipitation type. More...
 
virtual void setVisibility (double distance)
 The visibility distance, specified in meters. More...
 
virtual double visibility () const
 
virtual void setWindDirection (double radians)
 The compass direction from which the wind is blowing, specified in radians. More...
 
virtual double windDirection () const
 
virtual void setWindSpeed (double value)
 The speed the wind is blowing, specified in meters per second. More...
 
virtual double windSpeed () const
 
virtual void setAirTurbulence (int value)
 The intensity of the air turbulence. More...
 
virtual int airTurbulence () const
 
virtual bool airTurbulenceSpecified () const
 Indicates whether or not the air turbulence is specified in the message. More...
 
virtual void clearAirTurbulence ()
 Clears the specified flag for air turbulence. More...
 
virtual void setUnderwaterVisibility (double underwaterVisibility)
 Underwater visibility in meters. More...
 
virtual double underwaterVisibility () const
 
virtual bool underwaterVisibilitySpecified () const
 Indicates whether or not the underwater visibility is specified in the message. More...
 
virtual void clearUnderwaterVisibility ()
 Clears the specified flag for underwater visibility. More...
 
virtual void setSurfaceTransparency (double transparency)
 Surface transparency (percentage) More...
 
virtual double surfaceTransparency () const
 
virtual bool surfaceTransparencySpecified () const
 Indicates whether or not the underwater visibility is specified in the message. More...
 
virtual void clearSurfaceTransparency ()
 Clears the specified flag for underwater visibility. More...
 
virtual void setWaterCurrentSpeed (double waterCurrentSpeed)
 Water velocity in meters per second. More...
 
virtual double waterCurrentSpeed () const
 
virtual bool waterCurrentSpeedSpecified () const
 Indicates whether or not the water velocity is specified in the message. More...
 
virtual void clearWaterCurrentSpeed ()
 Clears the specified flag for water velocity. More...
 
virtual void setWaterCurrentDirection (double waterCurrentDirection)
 Water direction in radians clockwise from 0 (north) More...
 
virtual double waterCurrentDirection () const
 
virtual bool waterCurrentDirectionSpecified () const
 Indicates whether or not the visibility is specified in the message. More...
 
virtual void clearWaterCurrentDirection ()
 Clears the specified flag for visibility. More...
 
virtual void setAmbientWaterTemperature (double waterTemperature)
 Ambient water temperature in Celsius. More...
 
virtual double ambientWaterTemperature () const
 
virtual bool ambientWaterTemperatureSpecified () const
 Indicates whether or not the ambient water temperature is specified in the message. More...
 
virtual void clearAmbientWaterTemperature ()
 Clears the specified flag for ambient water temperature. More...
 
virtual void setTidalOffset (double tidalOffset)
 Tidal offset in meters from the water polygons in the database. More...
 
virtual double tidalOffset () const
 
virtual bool tidalOffsetSpecified () const
 Indicates whether or not the tidal offset is specified in the message. More...
 
virtual void clearTidalOffset ()
 Clears the specified flag for tidal offset. More...
 
virtual void setTidalDirection (bool tidalDirection)
 Tidal direction where true represents the tide going in and false represents the tide going out. More...
 
virtual bool tidalDirection () const
 
virtual bool tidalDirectionSpecified () const
 Indicates whether or not the tidal direction is specified in the message. More...
 
virtual void clearTidalDirection ()
 Clears the specified flag for tidal direction. More...
 
virtual void setSwellState (unsigned int state)
 Swell state according to the Douglas Sea Scale (integer 0 - 9) More...
 
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) More...
 
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) More...
 
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) More...
 
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) More...
 
virtual double choppiness () const
 
virtual bool choppinessSpecified () const
 
virtual void clearChoppiness ()
 
virtual void setSurgeDepth (double depth)
 Surge depth (meters) More...
 
virtual double surgeDepth () const
 
virtual bool surgeDepthSpecified () const
 
virtual void clearSurgeDepth ()
 
virtual void setFogHeight (double depth)
 Fog height (meters) More...
 
virtual double fogHeight () const
 
virtual bool fogHeightSpecified () const
 
virtual void clearFogHeight ()
 
virtual void setFogColor (const DtVector &)
 Fog color (x = red, y = green, z = blue) More...
 
virtual const DtVectorfogColor () const
 
virtual bool fogColorSpecified () const
 
virtual void clearFogColor ()
 
virtual void setSnowAccumulation (double snow)
 Snow Accumulation (meters) More...
 
virtual double snowAccumulation () const
 
virtual bool snowAccumulationSpecified () const
 
virtual void clearSnowAccumulation ()
 
virtual void setSnowMinimumAltitude (double snow)
 Snow Minimum Altitude (meters) More...
 
virtual double snowMinimumAltitude () const
 
virtual bool snowMinimumAltitudeSpecified () const
 
virtual void clearSnowMinimumAltitude ()
 
virtual void setSnowRoadAccumulation (double snow)
 Snow Road Accumulation (meters) More...
 
virtual double snowRoadAccumulation () const
 
virtual bool snowRoadAccumulationSpecified () const
 
virtual void clearSnowRoadAccumulation ()
 
virtual void setRainAccumulation (double rain)
 Rain Accumulation (meters) More...
 
virtual double rainAccumulation () const
 
virtual bool rainAccumulationSpecified () const
 
virtual void clearRainAccumulation ()
 
virtual void setThermoclineLayer1Depth (double depth)
 Thermocline depth (in meters) and permeability (0..1). More...
 
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 setLightningPresent (bool isPresent)
 Lightning Present. More...
 
virtual bool lightningPresent () const
 
virtual bool lightningPresentSpecified () const
 
virtual void clearLightningPresent ()
 
virtual void setGeneratedByRemoteWeatherSetter (bool value)
 Used internally by VRF. More...
 
virtual bool generatedByRemoteWeatherSetter () const
 
virtual void clearWindLevels ()
 
virtual bool windLevelsSpecified () const
 
virtual void clearWindLevelsSpecified ()
 
virtual void setWindLevels (const DtRwWindLevels &)
 Must be exact match. More...
 
virtual const DtRwWindLevelswindLevels () const
 
virtual DtRwWindLevelswindLevels ()
 
- Public Member Functions inherited from DtSimCommand
virtual ~DtSimCommand ()
 destructor More...
 
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. More...
 
virtual DtSimCommandclone () const
 Version of clone that preserves the existing name, and assigns a null parent registry. More...
 
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. 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 charnetRep ()
 
- 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 DtReaderWriteroperator= (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 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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is. More...
 
virtual const charxmlType () 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 DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified. More...
 
virtual DtReaderWriterdefaultRWValue ()
 
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object. More...
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 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 DtSimCommandcreator ()
 
- Static Public Member Functions inherited from DtChangeWeatherCommand
static DtSimCommandcreator ()
 
- Static Public Member Functions inherited from DtSimCommand
static DtSimCommandcreateSimCommand (DtlObjPtr mtlStream)
 Static functions. More...
 
static DtSimCommandcreateSimCommand (const DtSimCommandMessageType &simCommandType)
 
static void addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
 Adds a simCommand creator member function to the simCommand factory. More...
 
static void setFactory (DtSimCommandFactory *factory)
 
static DtSimCommandFactoryfactory ()
 
- 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 chartheXmlType ()
 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 DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within. More...
 
static DtReaderWritercreateFromEnvironment (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...
 

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 DtSimCommand
 DtSimCommand ()
 Constructors are protected because no one should instantiate the base class, just derived versions. More...
 
 DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
 constructor If you have a command 'put' itself, the write name will preface the command. More...
 
 DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor More...
 
const DtSimCommandoperator= (const DtSimCommand &orig)
 assignment operator; same as copy constructor More...
 
virtual charcreateNetworkBuffer ()
 
virtual bool isTypeRegistered (const DtSimCommandMessageType &commandType)
 
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter. More...
 
- Protected Attributes inherited from DtChangeWeatherCommand
DtRwReal myAirTurbidity
 
DtRwReal myAmbientAirTemperature
 
DtRwReal myAmbientAirPressure
 
DtRwReal myAirTemperatureAltitude
 
DtRwReal myAirPressureAltitude
 
DtRwBoolean myAirTemperatureAltitudeIsSeaLevel
 
DtRwBoolean myAirPressureAltitudeIsSeaLevel
 
DtRwReal mySeaLevelWaterConcentration
 
DtRwReal myPrecipitationIntensity
 
DtRwInt myPrecipitationType
 
DtRwInt myAirTurbulence
 
DtRwReal myUnderwaterVisibility
 
DtRwReal mySurfaceTransparency
 
DtRwReal myWaterCurrentSpeed
 
DtRwReal myWaterCurrentDirection
 
DtRwReal myAmbientWaterTemperature
 
DtRwReal myTidalOffset
 
DtRwBoolean myTidalDirection
 
DtRwInt mySwellState
 
DtRwReal mySwellStateDirection
 
DtRwInt mySeaState
 
DtRwReal mySeaStateDirection
 
DtRwBoolean myWindDrivenSeaStateEnabled
 
DtRwReal myChoppiness
 
DtRwReal mySurgeDepth
 
DtRwReal myThermoclineLayer1Depth
 
DtRwReal myThermoclineLayer1Permeability
 
DtRwReal myThermoclineLayer2Depth
 
DtRwReal myThermoclineLayer2Permeability
 
DtRwReal myThermoclineLayer3Depth
 
DtRwReal myThermoclineLayer3Permeability
 
DtRwReal myThermoclineLayer4Depth
 
DtRwReal myThermoclineLayer4Permeability
 
DtRwReal myThermoclineLayer5Depth
 
DtRwReal myThermoclineLayer5Permeability
 
DtRwInt myPriority
 
DtRwReal myFogHeight
 
DtRwVector myFogColor
 
DtRwReal mySnowAccumulation
 
DtRwReal mySnowMinimumAltitude
 
DtRwReal mySnowRoadAccumulation
 
DtRwReal myRainAccumulation
 
DtRwBoolean myGeneratedByRemoteWeatherSetter
 
DtRwUUID myUUID
 
DtRwWindLevels myWindLevels
 
DtRwBoolean myLightningPresent
 
- Protected Attributes inherited from DtSimCommand
charmyNetRep
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
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...
 
- Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactorymyFactory
 
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
 
static DtGetSelfCallbackInfo thePostGetSelfCallback
 
static DtPutSelfCallbackInfo thePrePutSelfCallback
 
static const DtVariableBindingsList theEmptyVariableBindingsList
 
static bool theCreatorFcnSet
 
static DtReaderWriterFactorytheFactory
 
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
 
static bool thePutIndent
 
static DtOutputStream * theOutputStream
 

Detailed Description

A DtSimCommand subclass which specifies a change to the global weather settings in the simulation engine.

The command may partially specify the global weather, such as specifying the wind and not the visibility. Only items that are specified will be changed by the command. Others will be left unchanged.

This class is provided only for backwards compatability

Constructor & Destructor Documentation

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand ( )

default constructor

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)

Usual constructor.

DtChangeGlobalWeatherCommand::DtChangeGlobalWeatherCommand ( const DtString writeName,
const DtChangeGlobalWeatherCommand orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

virtual DtChangeGlobalWeatherCommand::~DtChangeGlobalWeatherCommand ( )
virtual

destructor

Member Function Documentation

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

assignment operator

virtual const DtSimCommandMessageType& DtChangeGlobalWeatherCommand::type ( ) const
virtual
Returns
The type of this DtSimCommand (specified in radioMsgTypes.h)

Reimplemented from DtChangeWeatherCommand.

virtual DtSimCommand* DtChangeGlobalWeatherCommand::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual
Returns
A new instance of this class, copied from the original.

Reimplemented from DtChangeWeatherCommand.

static DtSimCommand* DtChangeGlobalWeatherCommand::creator ( )
static

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)