VR-Forces 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
DtRwIntegerAttribute Class Reference

class DtRwIntegerAttribute:

Instances of DtRwIntegerAttribute are readable/writeable DtIntegerAttributes.

Inheritance diagram for DtRwIntegerAttribute:
Inheritance graph
[legend]

Public Member Functions

 DtRwIntegerAttribute (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwIntegerAttribute (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwIntegerAttribute (const DtString &name, const DtString &key, const int &data, DtReaderWriterRegistry *const parentRegistry=NULL)
 
 DtRwIntegerAttribute (const DtSymbolString &name, const DtString &key, const int &data, DtReaderWriterRegistry *const parentRegistry=NULL)
 
virtual ~DtRwIntegerAttribute ()
 
 DtRwIntegerAttribute (const DtRwIntegerAttribute &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwIntegerAttribute (const DtRwIntegerAttribute &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRwIntegerAttributeoperator= (const DtRwIntegerAttribute &orig)
 
DtIntegerAttributeoperator= (const DtIntegerAttribute &integerAttribute)
 
virtual void putData (std::string &fp, int indentlLevel=0)
 
virtual DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual void putData (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getData (const DtEnvironmentSP, const DtEnvValueSP, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
 
virtual const charreaderWriterType () const
 
virtual const charxmlType () const
 
bool operator== (const DtRwIntegerAttribute &) const
 
bool operator!= (const DtRwIntegerAttribute &rhs) 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 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 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 putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
 
virtual void getSelf (const DtEnvironmentSP, const DtEnvValueSP root, 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)
 
- Public Member Functions inherited from DtIntegerAttribute
 DtIntegerAttribute ()
 
 DtIntegerAttribute (const DtString &key, int data)
 
virtual ~DtIntegerAttribute ()
 
 DtIntegerAttribute (const DtIntegerAttribute &orig)
 
DtIntegerAttributeoperator= (const DtIntegerAttribute &orig)
 
bool operator== (const DtIntegerAttribute &rhs) const
 
const DtStringkey () const
 
DtStringkey ()
 
void setKey (const DtString &newKey)
 
int data () const
 
void setData (int newData)
 

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)
 

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)
 
- 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
 
- Protected Attributes inherited from DtIntegerAttribute
DtString myKey
 
int myData
 
- 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

DtRwIntegerAttribute::DtRwIntegerAttribute ( const DtString name = DtString::nullString(),
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructors - Set up to perform reader/writer operations correctly.

DtRwIntegerAttribute::DtRwIntegerAttribute ( const DtSymbolString name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwIntegerAttribute::DtRwIntegerAttribute ( const DtString name,
const DtString key,
const int data,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwIntegerAttribute::DtRwIntegerAttribute ( const DtSymbolString name,
const DtString key,
const int data,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
virtual DtRwIntegerAttribute::~DtRwIntegerAttribute ( )
virtual

destructor

DtRwIntegerAttribute::DtRwIntegerAttribute ( const DtRwIntegerAttribute orig,
const DtString name = DtString::nullString(),
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

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

Member Function Documentation

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

assignment operator:

DtIntegerAttribute& DtRwIntegerAttribute::operator= ( const DtIntegerAttribute integerAttribute)

assignment from a DtIntegerAttribute.

virtual void DtRwIntegerAttribute::putData ( std::string &  fp,
int  indentlLevel = 0 
)
virtual

Overridden to write and read the new field (as local data) from/to file. Format for the type is as follows: ("name" <key> <data>)

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwIntegerAttribute::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths searchPaths,
const DtVariableBindingsList variableBindings 
)
virtual

Deriving class overrides these to get/put class specific data.

Reimplemented from DtReaderWriter.

virtual void DtRwIntegerAttribute::putData ( DtEnvironmentSP  ,
DtEnvValueSP  value 
) const
virtual

Override to add attributes of actual data.

Reimplemented from DtReaderWriter.

virtual void DtRwIntegerAttribute::getData ( const DtEnvironmentSP  ,
const DtEnvValueSP  ,
const DtReaderWriter::SearchPaths searchPaths = DtReaderWriter::SearchPaths(),
const DtVariableBindingsList bindings = DtVariableBindingsList() 
)
virtual

Gets data from the environment value.

Reimplemented from DtReaderWriter.

virtual const char* DtRwIntegerAttribute::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* DtRwIntegerAttribute::theXmlType ( )
static

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

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

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

bool DtRwIntegerAttribute::operator== ( const DtRwIntegerAttribute ) const
bool DtRwIntegerAttribute::operator!= ( const DtRwIntegerAttribute rhs) const
inline

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)