DtSetStateProperties Class Reference

File: setStateProperties.h.

Class: DtSetStateProperties DtSetStateProperties sets the state properties of the given entity. If the "replace" flag is set, then, all properties are replaced directly into the entities state properties (this gives the ability to add or remove properties).

Each property is looked up by name in the entities stateProperties(). If the property is not found and "replace" is specified that property is added, else no action is taken. If the property is found and the "replace" flag is not specified, the property supplied is scanned for existing items in the stateProperties() and if a property exists, it is replaced, else no action is taken

set-data-request-type: DtSetStatePropertiesType

Related Examples

• Add State Property
• Display State Data

Inheritance diagram for DtSetStateProperties:

Public Member Functions
	DtSetStateProperties ()
	DtSetStateProperties (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetStateProperties (const DtString &writeName, const DtSetStateProperties &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetStateProperties &	operator= (const DtSetStateProperties &orig)
virtual	~DtSetStateProperties () override
virtual const DtSetMessageType &	type () const override
virtual DtSetDataRequest *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	stringRep () const override
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	changeProperty (DtPropertyInterface *)
virtual void	setStateProperties (const DtRwProperties &)
virtual const DtRwProperties &	stateProperties () const
virtual void	addProperty (const DtPropertyInterface &)
virtual void	setReplace (bool)
virtual bool	replace () const
virtual void	setValuesArePercentages (bool)
virtual bool	valuesArePercentages () const
virtual void	setAddIfMissing (bool)
virtual bool	addIfMissing () const
virtual void	setProperties (const DtString &)
virtual const DtString &	properties () const
Public Member Functions inherited from DtSetDataRequest
virtual	~DtSetDataRequest () override
virtual bool	init ()
virtual void	putData (std::string &fp, int indentLevel=0) override
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
virtual char *	netRep ()
virtual bool	isOneClick () 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) const
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	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 bool	fromXml (const DtString &)
virtual bool	fromXmlFile (const DtFilename &)
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 DtSetDataRequest *	creator ()
Static Public Member Functions inherited from DtSetDataRequest
static DtSetDataRequest *	createSetDataRequest (DtlObjPtr mtlStream)
static DtSetDataRequest *	createSetDataRequest (DtSetMessageType requestType)
static void	addSetDataRequestCreatorFcn (const DtSetMessageType &setDataName, DtSetDataRequestCreatorFcn fcn)
static void	setFactory (DtSetDataRequestFactory *factory)
static DtSetDataRequestFactory *	factory ()
static bool	isTypeRegistered (DtSetMessageType setDataType)
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
DtRwProperties	myStateProperties
DtRwBoolean	myReplace
DtRwBoolean	myValuesArePercentages
DtRwBoolean	myAddIfMissing
DtRwString	myProperties
Protected Attributes inherited from DtSetDataRequest
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
bool	myInvalid
bool	myChangedFlag

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 DtSetDataRequest
	DtSetDataRequest ()
	DtSetDataRequest (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	DtSetDataRequest (const DtString &writeName, const DtSetDataRequest &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtSetDataRequest &	operator= (const DtSetDataRequest &orig)
virtual char *	createNetworkBuffer ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
Static Protected Attributes inherited from DtSetDataRequest
static DtSetDataRequestFactory *	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

DtSetStateProperties::DtSetStateProperties

(

)

default constructor

DtSetStateProperties::DtSetStateProperties	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a request 'put' itself, the writeName will preface it.

DtSetStateProperties::DtSetStateProperties	(	const DtString &	writeName,
		const DtSetStateProperties &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtSetStateProperties::~DtSetStateProperties ( )

overridevirtual

Member Function Documentation

const DtSetStateProperties& DtSetStateProperties::operator=

(

const DtSetStateProperties &

orig

)

assignment operator

virtual const DtSetMessageType& DtSetStateProperties::type ( ) const

overridevirtual

Returns DtSetStatePropertiesType.

Implements DtSetDataRequest.

virtual DtSetDataRequest* DtSetStateProperties::clone ( const DtString &  name, DtReaderWriterRegistry *  parentRegistry = 0  ) const

overridevirtual

Creates a copy of the request.

Implements DtSetDataRequest.

virtual DtString DtSetStateProperties::stringRep ( ) const

overridevirtual

Get a readable string representation of this setDataRequest.

Implements DtSetDataRequest.

virtual int DtSetStateProperties::netRepSize ( ) const

overridevirtual

Returns the size of the full network representation (altitude included) padded to an 8-byte boundary.

Reimplemented from DtSetDataRequest.

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

overridevirtual

Fills in the request from the network buffer.

Reimplemented from DtSetDataRequest.

virtual bool DtSetStateProperties::setToNet ( )

overridevirtual

Fills in the network buffer (created by base class setDataRequest) with the set data request contents.

Reimplemented from DtSetDataRequest.

static DtSetDataRequest* DtSetStateProperties::creator ( )

static

virtual void DtSetStateProperties::changeProperty ( DtPropertyInterface *  )

virtual

if simply wanting to change a property, add it here. This class will take ownership of the property, so, do not delete the pointer passed int

virtual void DtSetStateProperties::setStateProperties ( const DtRwProperties &  )

virtual

Sets the properties to be replaced.

virtual const DtRwProperties& DtSetStateProperties::stateProperties ( ) const

virtual

virtual void DtSetStateProperties::addProperty ( const DtPropertyInterface &  )

virtual

Adds a new property into the stateProperties. Will clone the property when adding.

virtual void DtSetStateProperties::setReplace ( bool  )

virtual

Sets whether or not to replace wholesale or simply look for matching items. Default is to look for matching items.

virtual bool DtSetStateProperties::replace ( ) const

virtual

virtual void DtSetStateProperties::setValuesArePercentages ( bool  )

virtual

The values supplied are percentages (0 - 1) of what should be set as the base value of that entry. The assumption is there is a value "Base-" + property name that can be found to set the new value to.

virtual bool DtSetStateProperties::valuesArePercentages ( ) const

virtual

virtual void DtSetStateProperties::setAddIfMissing ( bool  )

virtual

Sets whether or not a specified state property that does not exist for the entity should be added.

virtual bool DtSetStateProperties::addIfMissing ( ) const

virtual

virtual void DtSetStateProperties::setProperties ( const DtString &  )

virtual

Used for the front-end, this will be a hint as to what set menu item was responsible for creating this set. No need to use if not being used from the front-end.

virtual const DtString& DtSetStateProperties::properties ( ) const

virtual

Member Data Documentation

DtRwProperties DtSetStateProperties::myStateProperties

protected

DtRwBoolean DtSetStateProperties::myReplace

protected

DtRwBoolean DtSetStateProperties::myValuesArePercentages

protected

DtRwBoolean DtSetStateProperties::myAddIfMissing

protected

DtRwString DtSetStateProperties::myProperties

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrftasks/setStateProperties.h