A DtSimCommand subclass which specifies a change to the cloud layer settings for the specified cloud layer in the simulation engine. More...

Inheritance diagram for DtChangeCloudLayerCommand:

[legend]

Public Member Functions
	DtChangeCloudLayerCommand ()
	default constructor More...

	DtChangeCloudLayerCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	Usual constructor. More...

	DtChangeCloudLayerCommand (const DtString &writeName, const DtChangeCloudLayerCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

virtual	~DtChangeCloudLayerCommand ()
	destructor More...

DtChangeCloudLayerCommand &	operator= (const DtChangeCloudLayerCommand &orig)
	assignment operator More...

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. 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 bool	operator== (const DtChangeCloudLayerCommand &) const

virtual bool	operator!= (const DtChangeCloudLayerCommand &rhs) const

virtual void	setAllValuesSpecified (bool)
	Sets all values to be specified/not specified. 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 DtUUID &	uuid () const

virtual bool	fromXml (const DtString &s)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &s)
	Restores object from given xml file. More...


virtual void	setCloudType (CloudLayerCloudType factor)
	The cloud type. More...

virtual CloudLayerCloudType	cloudType () const

virtual bool	cloudTypeSpecified () const
	Indicates whether or not the cloud type is specified in the message. More...

virtual void	clearCloudType ()
	Clears the specified flag for cloud type. More...


virtual void	setCloudAltitude (double value)
	The cloud altitude. More...

virtual double	cloudAltitude () const

virtual bool	cloudAltitudeSpecified () const
	Indicates whether or not the cloud altitude is specified in the message. More...

virtual void	clearCloudAltitude ()
	Clears the specified flag for cloud altitude. More...


virtual void	setCloudThickness (double value)
	The cloud thickness. More...

virtual double	cloudThickness () const

virtual bool	cloudThicknessSpecified () const
	Indicates whether or not the cloud thickness is specified in the message. More...

virtual void	clearCloudThickness ()
	Clears the specified flag for cloud thickness. More...


virtual void	setCornerRadius (double value)
	The cloud corner radius. More...

virtual double	cornerRadius () const

virtual bool	cornerRadiusSpecified () const
	Indicates whether or not the cloud thickness is specified in the message. More...

virtual void	clearCornerRadius ()
	Clears the specified flag for cloud thickness. More...


virtual void	setCloudDensity (double value)
	The cloud density. More...

virtual double	cloudDensity () const

virtual bool	cloudDensitySpecified () const
	Indicates whether or not the cloud density is specified in the message. More...

virtual void	clearCloudDensity ()
	Clears the specified flag for cloud density. More...


virtual void	setLightningPresent (bool isPresent)
	Lighting present. More...

virtual double	lightningPresent () const

virtual bool	lightningPresentSpecified () const
	Indicates whether or not the lightning present is specified in the message. More...

virtual void	clearLightningPresent ()
	Clears the specified flag for lighting present. More...

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 DtSimCommand *	clone () 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 char *	netRep ()

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 DtReaderWriter &	operator= (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	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. 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 aliasContainer &	aliases () 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 char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () 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 DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified. More...

virtual DtReaderWriter *	defaultRWValue ()

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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

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. 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 DtSimCommand *	creator ()

Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
	Static functions. More...

static DtSimCommand *	createSimCommand (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 DtSimCommandFactory *	factory ()

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 char *	theXmlType ()
	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 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. More...

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (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...

Protected Attributes
DtRwInt	myCloudType

DtRwReal	myCloudAltitude

DtRwReal	myCloudThickness

DtRwReal	myCornerRadius

DtRwReal	myCloudDensity

DtRwBoolean	myLightningPresent

DtRwUUID	myUUID

Protected Attributes inherited from DtSimCommand
char *	myNetRep

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. 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...

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 DtSimCommand &	operator= (const DtSimCommand &orig)
	assignment operator; same as copy constructor More...

virtual char *	createNetworkBuffer ()

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...

Static Protected Attributes inherited from DtSimCommand
static DtSimCommandFactory *	myFactory

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

Detailed Description

A DtSimCommand subclass which specifies a change to the cloud layer settings for the specified cloud layer in the simulation engine.

The command may partially specify the cloud layer, such as specifying the cloud type and not the altitude. Only items that are specified will be changed by the command. Others will be left unchanged.

Constructor & Destructor Documentation

DtChangeCloudLayerCommand::DtChangeCloudLayerCommand ( )

default constructor

DtChangeCloudLayerCommand::DtChangeCloudLayerCommand	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Usual constructor.

DtChangeCloudLayerCommand::DtChangeCloudLayerCommand	(	const DtString &	writeName,
		const DtChangeCloudLayerCommand &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtChangeCloudLayerCommand::~DtChangeCloudLayerCommand ( )

virtual

destructor

Member Function Documentation

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

assignment operator

virtual const DtSimCommandMessageType& DtChangeCloudLayerCommand::type ( ) const

virtual

Returns: The type of this DtSimCommand (specified in radioMsgTypes.h)

Implements DtSimCommand.

virtual DtSimCommand* DtChangeCloudLayerCommand::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)		const

virtual

Returns: A new instance of this class, copied from the original.

Implements DtSimCommand.

virtual int DtChangeCloudLayerCommand::netRepSize ( ) const

virtual

Returns the size in bytes of the network representation of the class.

This is the size in bytes of the DtNetSimSimCommand structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).

Reimplemented from DtSimCommand.

virtual bool DtChangeCloudLayerCommand::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)

virtual

Sets mySubsimCommand member from the incoming contentBuffer (cast to type DtNetSimSimCommand).

Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual bool DtChangeCloudLayerCommand::setToNet ( )

virtual

Calls netRep() to create the network buffer.

Casts the resulting myNetRep to type DtNetSimSimCommand*, and then sets the mySubsimCommand member in the DtNetSimSimCommand from mySubsimCommand. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimCommand::netRepSize().

Reimplemented from DtSimCommand.

virtual void DtChangeCloudLayerCommand::setCloudType ( CloudLayerCloudType factor )

virtual

The cloud type.

virtual CloudLayerCloudType DtChangeCloudLayerCommand::cloudType ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::cloudTypeSpecified ( ) const

virtual

Indicates whether or not the cloud type is specified in the message.

virtual void DtChangeCloudLayerCommand::clearCloudType ( )

virtual

Clears the specified flag for cloud type.

virtual void DtChangeCloudLayerCommand::setCloudAltitude ( double value )

virtual

The cloud altitude.

virtual double DtChangeCloudLayerCommand::cloudAltitude ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::cloudAltitudeSpecified ( ) const

virtual

Indicates whether or not the cloud altitude is specified in the message.

virtual void DtChangeCloudLayerCommand::clearCloudAltitude ( )

virtual

Clears the specified flag for cloud altitude.

virtual void DtChangeCloudLayerCommand::setCloudThickness ( double value )

virtual

The cloud thickness.

virtual double DtChangeCloudLayerCommand::cloudThickness ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::cloudThicknessSpecified ( ) const

virtual

Indicates whether or not the cloud thickness is specified in the message.

virtual void DtChangeCloudLayerCommand::clearCloudThickness ( )

virtual

Clears the specified flag for cloud thickness.

virtual void DtChangeCloudLayerCommand::setCornerRadius ( double value )

virtual

The cloud corner radius.

virtual double DtChangeCloudLayerCommand::cornerRadius ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::cornerRadiusSpecified ( ) const

virtual

Indicates whether or not the cloud thickness is specified in the message.

virtual void DtChangeCloudLayerCommand::clearCornerRadius ( )

virtual

Clears the specified flag for cloud thickness.

virtual void DtChangeCloudLayerCommand::setCloudDensity ( double value )

virtual

The cloud density.

virtual double DtChangeCloudLayerCommand::cloudDensity ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::cloudDensitySpecified ( ) const

virtual

Indicates whether or not the cloud density is specified in the message.

virtual void DtChangeCloudLayerCommand::clearCloudDensity ( )

virtual

Clears the specified flag for cloud density.

virtual void DtChangeCloudLayerCommand::setLightningPresent ( bool isPresent )

virtual

Lighting present.

virtual double DtChangeCloudLayerCommand::lightningPresent ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::lightningPresentSpecified ( ) const

virtual

Indicates whether or not the lightning present is specified in the message.

virtual void DtChangeCloudLayerCommand::clearLightningPresent ( )

virtual

Clears the specified flag for lighting present.

virtual bool DtChangeCloudLayerCommand::operator== ( const DtChangeCloudLayerCommand & ) const

virtual

virtual bool DtChangeCloudLayerCommand::operator!= ( const DtChangeCloudLayerCommand & rhs ) const

inlinevirtual

virtual void DtChangeCloudLayerCommand::setAllValuesSpecified ( bool )

virtual

Sets all values to be specified/not specified.

virtual DtString DtChangeCloudLayerCommand::stringRep ( ) const

virtual

Text representation of this command.

Implements DtSimCommand.

static DtSimCommand* DtChangeCloudLayerCommand::creator ( )

static

virtual void DtChangeCloudLayerCommand::setUUID ( const DtUUID & )

virtual

The name of the object to set the weather for. If blank will change global weather.

virtual const DtUUID& DtChangeCloudLayerCommand::uuid ( ) const

virtual

virtual bool DtChangeCloudLayerCommand::fromXml ( const DtString & )

virtual

Restores object from given xml string. Returns true if valid.

Reimplemented from DtReaderWriter.

virtual bool DtChangeCloudLayerCommand::fromXmlFile ( const DtFilename & )

virtual

Restores object from given xml file.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtRwInt DtChangeCloudLayerCommand::myCloudType

protected

DtRwReal DtChangeCloudLayerCommand::myCloudAltitude

protected

DtRwReal DtChangeCloudLayerCommand::myCloudThickness

protected

DtRwReal DtChangeCloudLayerCommand::myCornerRadius

protected

DtRwReal DtChangeCloudLayerCommand::myCloudDensity

protected

DtRwBoolean DtChangeCloudLayerCommand::myLightningPresent

protected

DtRwUUID DtChangeCloudLayerCommand::myUUID

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfplan/changeCloudLayerCommand.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation