DtChangeCloudLayerCommand Class Reference

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.

Inheritance diagram for DtChangeCloudLayerCommand:

Public Member Functions
	DtChangeCloudLayerCommand ()
	DtChangeCloudLayerCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtChangeCloudLayerCommand (const DtString &writeName, const DtChangeCloudLayerCommand &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtChangeCloudLayerCommand ()
DtChangeCloudLayerCommand &	operator= (const DtChangeCloudLayerCommand &orig)
virtual const DtSimCommandMessageType &	type () const
virtual DtSimCommand *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual bool	operator== (const DtChangeCloudLayerCommand &) const
virtual bool	operator!= (const DtChangeCloudLayerCommand &rhs) const
virtual void	setAllValuesSpecified (bool)
virtual DtString	stringRep () const
virtual void	setUUID (const DtUUID &)
virtual const DtUUID &	uuid () const
virtual bool	fromXml (const DtString &s)
virtual bool	fromXmlFile (const DtFilename &s)
virtual void	setCloudType (CloudLayerCloudType factor)
virtual CloudLayerCloudType	cloudType () const
virtual bool	cloudTypeSpecified () const
virtual void	clearCloudType ()
virtual void	setCloudAltitude (double value)
virtual double	cloudAltitude () const
virtual bool	cloudAltitudeSpecified () const
virtual void	clearCloudAltitude ()
virtual void	setCloudThickness (double value)
virtual double	cloudThickness () const
virtual bool	cloudThicknessSpecified () const
virtual void	clearCloudThickness ()
virtual void	setCornerRadius (double value)
virtual double	cornerRadius () const
virtual bool	cornerRadiusSpecified () const
virtual void	clearCornerRadius ()
virtual void	setCloudDensity (double value)
virtual double	cloudDensity () const
virtual bool	cloudDensitySpecified () const
virtual void	clearCloudDensity ()
virtual void	setLightningPresent (bool isPresent)
virtual bool	lightningPresent () const
virtual bool	lightningPresentSpecified () const
virtual void	clearLightningPresent ()
Public Member Functions inherited from DtSimCommand
virtual	~DtSimCommand ()
virtual bool	init ()
virtual DtSimCommand *	clone () const
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual char *	netRep ()
virtual void	setLocalDelivery (bool)
virtual bool	localDelivery () const
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
bool	operator== (const DtReaderWriter &) const
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual void	postPutSelf ()
virtual void	prePutSelf ()
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	postGetSelf ()
virtual void	preGetSelf ()
virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
virtual DtSymbolString	name () const
virtual void	addAlias (const DtSymbolString &alias)
virtual void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
bool	isReadonly () const
virtual void	reset ()
virtual int	alignment () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
virtual void	setName (const DtString &)
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
virtual bool	hasVariableReference () const
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
virtual void	recordUpdateTime () const
virtual bool	wasUpdatedSince (DtTime t) const
virtual bool	changedSinceLastChecked ()
virtual bool	peekChangedSinceLastChecked () const
virtual void	setValueSpecified (bool specified, bool recurse=false)
virtual bool	valueSpecified () const
virtual bool	isVariableReference () const
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
virtual DtSymbolString	variableName () const
virtual void	setVariableName (const DtSymbolString variableName)
virtual const DtReaderWriter *	defaultRWValue () const
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
const DtReaderWriterRegistry &	registry () const
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
virtual bool	toXml (const DtFilename &) const
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
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())
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtSimCommand *	creator ()
Static Public Member Functions inherited from DtSimCommand
static DtSimCommand *	createSimCommand (DtlObjPtr mtlStream)
static DtSimCommand *	createSimCommand (const DtSimCommandMessageType &simCommandType)
static DtSimCommand *	createFromFactory (const DtSimCommandMessageType &simCommandType)
static void	addSimCommandCreatorFcn (const DtSimCommandMessageType &simCommandName, DtSimCommandCreatorFcn fcn)
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 ()
static const DtFilename &	appPath ()
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
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)
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Attributes
DtRwInt	myCloudType
DtRwReal	myCloudAltitude
DtRwReal	myCloudThickness
DtRwReal	myCornerRadius
DtRwReal	myCloudDensity
DtRwBoolean	myLightningPresent
DtRwUUID	myUUID
Protected Attributes inherited from DtSimCommand
char *	myNetRep
bool	myLocalDelivery
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
bool	myInvalid
bool	myChangedFlag

Additional Inherited Members
Public Types inherited from DtSimCommand
typedef DtSimCommandMessageType	FactoryKeyType
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 ()
	DtSimCommand (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSimCommand (const DtString &writeName, const DtSimCommand &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSimCommand &	operator= (const DtSimCommand &orig)
virtual char *	createNetworkBuffer ()
virtual bool	isTypeRegistered (const DtSimCommandMessageType &commandType)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
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

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

The cloud type.

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

The cloud altitude.

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

The cloud thickness.

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

The cloud corner radius.

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

The cloud density.

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 bool DtChangeCloudLayerCommand::lightningPresent ( ) const

virtual

Lighting present.

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.vrf5-0-branch/include/vrfplan/changeCloudLayerCommand.h