VR-Forces 5.0.2 Developer's Guide
 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
DtRwStatePropertyInitialization Class Reference
Inheritance diagram for DtRwStatePropertyInitialization:
Inheritance graph
[legend]

Public Member Functions

 DtRwStatePropertyInitialization ()
 
 DtRwStatePropertyInitialization (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwStatePropertyInitialization (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwStatePropertyInitialization (const DtString &name, const DtRwStatePropertyInitialization &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwStatePropertyInitialization (const DtSymbolString &name, const DtRwStatePropertyInitialization &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
const
DtRwStatePropertyInitialization
operator= (const DtRwStatePropertyInitialization &orig)
 
virtual ~DtRwStatePropertyInitialization ()
 
virtual
DtRwStatePropertyInitialization
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual
DtRwStatePropertyInitialization
clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
bool operator== (const DtRwStatePropertyInitialization &rhs) const
 
bool operator!= (const DtRwStatePropertyInitialization &rhs) const
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
virtual DtString statePropertyName () const
 
virtual void setStatePropertyName (const DtString &val)
 
virtual double realValue () const
 
virtual void setRealValue (double val)
 
virtual bool realValueSpecified () const
 
virtual int intValue () const
 
virtual void setIntValue (int val)
 
virtual bool intValueSpecified () const
 
virtual bool boolValue () const
 
virtual void setBoolValue (bool val)
 
virtual bool boolValueSpecified () const
 
virtual DtString stringValue () const
 
virtual void setStringValue (const DtString &val)
 
virtual bool stringValueSpecified () 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 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 putData (std::string &fp, int indentLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
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 DtReaderWriterdefaultRWValue () const
 
virtual DtReaderWriterdefaultRWValue ()
 
virtual void setDefaultRWValue (DtReaderWriter *)
 
virtual bool checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 
const DtReaderWriterRegistryregistry () const
 
DtReaderWriterRegistryregistry ()
 
virtual DtPropertyInterfaceproperty ()
 
virtual const DtPropertyInterfaceproperty () const
 
virtual DtString toXml () const
 
virtual DtRwVariableBindingsgenerateVariableBindings () 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 const chartheXmlType ()
 
- 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 ()
 
static const DtFilename & appPath ()
 
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 
static void createReaderWriterFactory ()
 
static void cleanupFactory ()
 
static DtReaderWriterFactoryfactory ()
 
static void setOutputStream (DtOutputStream *stream)
 
static DtOutputStream & outputStream ()
 
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 
static DtString getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
 

Protected Attributes

parameters

These parameters are available for setting in the OPD files.

DtRwString myStatePropertyName
 
DtRwReal myRealValue
 
DtRwInt myIntValue
 
DtRwBoolean myBoolValue
 
DtRwString myStringValue
 
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
 
DtReaderWriterRegistry myRegistry
 
DtReaderWriterRegistrymyParentRegistry
 
bool myValueSpecified
 
bool myReadOnlyFlag
 
bool myIsVariableReference
 
DtSymbolString myVariableName
 
bool myVariableIsBound
 
DtReaderWritermyDefaultValue
 
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 DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 
- 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
 

Constructor & Destructor Documentation

DtRwStatePropertyInitialization::DtRwStatePropertyInitialization ( )

default constructor

DtRwStatePropertyInitialization::DtRwStatePropertyInitialization ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtRwStatePropertyInitialization::DtRwStatePropertyInitialization ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtRwStatePropertyInitialization::DtRwStatePropertyInitialization ( const DtString name,
const DtRwStatePropertyInitialization orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtRwStatePropertyInitialization::DtRwStatePropertyInitialization ( const DtSymbolString name,
const DtRwStatePropertyInitialization orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtRwStatePropertyInitialization::~DtRwStatePropertyInitialization ( )
virtual

Member Function Documentation

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

assignment operator

virtual DtRwStatePropertyInitialization* DtRwStatePropertyInitialization::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual DtRwStatePropertyInitialization* DtRwStatePropertyInitialization::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual
virtual DtString DtRwStatePropertyInitialization::statePropertyName ( ) const
virtual

Accessor/mutator for myStatePropertyName.

virtual void DtRwStatePropertyInitialization::setStatePropertyName ( const DtString val)
virtual

Accessor/mutator for myStatePropertyName.

virtual double DtRwStatePropertyInitialization::realValue ( ) const
virtual

Accessor/mutator for myRealValue.

virtual void DtRwStatePropertyInitialization::setRealValue ( double  val)
virtual

Accessor/mutator for myRealValue.

virtual bool DtRwStatePropertyInitialization::realValueSpecified ( ) const
virtual

Accessor/mutator for myRealValue.

virtual int DtRwStatePropertyInitialization::intValue ( ) const
virtual

Accessor/mutator for myIntValue.

virtual void DtRwStatePropertyInitialization::setIntValue ( int  val)
virtual

Accessor/mutator for myIntValue.

virtual bool DtRwStatePropertyInitialization::intValueSpecified ( ) const
virtual

Accessor/mutator for myIntValue.

virtual bool DtRwStatePropertyInitialization::boolValue ( ) const
virtual

Accessor/mutator for myBoolValue.

virtual void DtRwStatePropertyInitialization::setBoolValue ( bool  val)
virtual

Accessor/mutator for myBoolValue.

virtual bool DtRwStatePropertyInitialization::boolValueSpecified ( ) const
virtual

Accessor/mutator for myBoolValue.

virtual DtString DtRwStatePropertyInitialization::stringValue ( ) const
virtual

Accessor/mutator for myStringValue.

virtual void DtRwStatePropertyInitialization::setStringValue ( const DtString val)
virtual

Accessor/mutator for myStringValue.

virtual bool DtRwStatePropertyInitialization::stringValueSpecified ( ) const
virtual

Accessor/mutator for myStringValue.

bool DtRwStatePropertyInitialization::operator== ( const DtRwStatePropertyInitialization rhs) const

Equivalence operator.

bool DtRwStatePropertyInitialization::operator!= ( const DtRwStatePropertyInitialization rhs) const
inline
virtual const char* DtRwStatePropertyInitialization::readerWriterType ( ) const
virtual

Used to supply a string type that this reader writer type is. This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create.

Reimplemented from DtReaderWriter.

static const char* DtRwStatePropertyInitialization::theXmlType ( )
static

The type that is used when archiving to an XML stream.

virtual const char* DtRwStatePropertyInitialization::xmlType ( ) const
inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwString DtRwStatePropertyInitialization::myStatePropertyName
protected

Parameter Name: state-property-name
Parameter Description: The name of the state property to set.
Parameter Default Value: ""
.

DtRwReal DtRwStatePropertyInitialization::myRealValue
protected

Parameter Name: real-value
Parameter Description: The value to set if the state property is a DtRwReal.
Parameter Default Value: 0
.

DtRwInt DtRwStatePropertyInitialization::myIntValue
protected

Parameter Name: int-value
Parameter Description: The value to set if the state property is a DtRwInt.
Parameter Default Value: 0
.

DtRwBoolean DtRwStatePropertyInitialization::myBoolValue
protected

Parameter Name: bool-value
Parameter Description: The value to set if the state property is a DtRwBoolean.
Parameter Default Value: false
.

DtRwString DtRwStatePropertyInitialization::myStringValue
protected

Parameter Name: string-value
Parameter Description: The value to set if the state property is a DtRwString.
Parameter Default Value: ""
.


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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)