VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes
DtRwInt Class Reference

Description: Readable, Writable int. More...

Inheritance diagram for DtRwInt:
Inheritance graph
[legend]

Public Member Functions

 DtRwInt ()
 default constructor
 DtRwInt (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor
 DtRwInt (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
 DtRwInt (const DtString &name, int value, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor from an int
 DtRwInt (const DtSymbolString &name, int value, DtReaderWriterRegistry *const parentRegistry=NULL)
 real constructor from an int
 DtRwInt (int orig, DtReaderWriterRegistry *const parentRegistry=NULL)
 copy constructor
 DtRwInt (const DtRwInt &orig, DtReaderWriterRegistry *const parentRegistry=NULL)
DtRwIntoperator= (const DtRwInt &orig)
 assign to int... assigns value only
virtual ~DtRwInt ()
virtual operator const int () const
 additional operator overrides
int operator= (const int orig)
 assign from int
virtual int operator- () const
virtual int operator* (const int rhs) const
virtual int operator/ (const int rhs) const
virtual int operator+ (const int rhs) const
virtual int operator- (const int rhs) const
virtual int operator< (const int rhs) const
virtual int operator> (const int rhs) const
virtual int operator<= (const int rhs) const
virtual int operator>= (const int rhs) const
virtual int operator== (const int rhs) const
virtual int operator!= (const int rhs) const
virtual int operator*= (const int rhs)
virtual int operator/= (const int rhs)
virtual int operator+= (const int rhs)
virtual int operator-= (const int rhs)
virtual int operator% (const int rhs)
virtual int operator%= (const int rhs)
virtual int operator-- (int)
virtual int operator-- ()
virtual int operator++ (int)
virtual int operator++ ()
virtual int value () const
virtual void setValue (int value)
virtual void putData (FILE *fp, int indentLevel=0)
 Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
virtual DtString prettyPrint () const
 Routine to return a human readable form of this variable.
- Public Member Functions inherited from DtReaderWriter
 DtReaderWriter ()
 default constructor
 DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 real constructor Setting the readonly flag prevents object from writing itself to the stream.
 DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
 DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
virtual void writeSelf (FILE *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.
virtual DtSymbolString name () const
 Accessor for name of this readable/writable object.
virtual void addAlias (const DtSymbolString &alias)
 Add an alias as an alternative name for this object.
virtual bool hasAlias (const DtSymbolString &alias)
virtual const aliasContaineraliases () const
virtual void setReadonly (bool flag)
 Set read-only flag.
virtual bool isReadonly () const
virtual bool variableIsBound () const
virtual void unbindVariable ()
 Sets the myVariableIsBound flag to false.
virtual void setName (const DtString &)
 Set the name of the object.
virtual void bindVariables (DtVariableBindingsList variableBindings)
 Runs a variable binding pass on this reader writer and any of its children.
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.
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
 The specified flags are used for optional values.
virtual bool isVariableReference () const
 Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void setIsVariableReference (bool value)
virtual void clearAllVariableReferenceFlags ()
 Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString variableName () const
 The variable name, if this object is a variable reference.
virtual void setVariableName (const DtSymbolString variableName)
 The variable name, if this object is a variable reference.
const DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes

int myValue
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
aliasContainer myAliases
 Container for the aliases which represent alternative names for the object.
bool myInvalid
 Set to true if there is a problem reading this item.

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::pair
< DtSymbolString, DtString
DtVariableNameType
typedef DtReaderWriterFactory *(* DtReaderWriterFactoryCreatorFcn )()
- Static Public Member Functions inherited from DtReaderWriter
static void putIndent (FILE *fp, int indentLevel)
static const
DtVariableBindingsList
nullVariableReference ()
static void setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename & appPath ()
 Gets the current working directory.
static void setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
 Sets the function to create the DtReaderWriterFactory.
static void createReaderWriterFactory ()
static DtReaderWriterFactoryfactory ()
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
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.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- 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

Detailed Description

Description: Readable, Writable int.

Constructor & Destructor Documentation

DtRwInt::DtRwInt ( )

default constructor

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

real constructor

DtRwInt::DtRwInt ( const DtSymbolString &  name,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
DtRwInt::DtRwInt ( const DtString name,
int  value,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructor from an int

DtRwInt::DtRwInt ( const DtSymbolString &  name,
int  value,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

real constructor from an int

DtRwInt::DtRwInt ( int  orig,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)

copy constructor

DtRwInt::DtRwInt ( const DtRwInt orig,
DtReaderWriterRegistry *const  parentRegistry = NULL 
)
virtual DtRwInt::~DtRwInt ( )
virtual

Member Function Documentation

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

assign to int... assigns value only

virtual DtRwInt::operator const int ( ) const
virtual

additional operator overrides

conversion to int operator

int DtRwInt::operator= ( const int  orig)

assign from int

virtual int DtRwInt::operator- ( ) const
virtual
virtual int DtRwInt::operator* ( const int  rhs) const
virtual
virtual int DtRwInt::operator/ ( const int  rhs) const
virtual
virtual int DtRwInt::operator+ ( const int  rhs) const
virtual
virtual int DtRwInt::operator- ( const int  rhs) const
virtual
virtual int DtRwInt::operator< ( const int  rhs) const
virtual
virtual int DtRwInt::operator> ( const int  rhs) const
virtual
virtual int DtRwInt::operator<= ( const int  rhs) const
virtual
virtual int DtRwInt::operator>= ( const int  rhs) const
virtual
virtual int DtRwInt::operator== ( const int  rhs) const
virtual
virtual int DtRwInt::operator!= ( const int  rhs) const
virtual
virtual int DtRwInt::operator*= ( const int  rhs)
virtual
virtual int DtRwInt::operator/= ( const int  rhs)
virtual
virtual int DtRwInt::operator+= ( const int  rhs)
virtual
virtual int DtRwInt::operator-= ( const int  rhs)
virtual
virtual int DtRwInt::operator% ( const int  rhs)
virtual
virtual int DtRwInt::operator%= ( const int  rhs)
virtual
virtual int DtRwInt::operator-- ( int  )
virtual
virtual int DtRwInt::operator-- ( )
virtual
virtual int DtRwInt::operator++ ( int  )
virtual
virtual int DtRwInt::operator++ ( )
virtual
virtual int DtRwInt::value ( ) const
virtual
virtual void DtRwInt::setValue ( int  value)
virtual
virtual void DtRwInt::putData ( FILE *  fp,
int  indentLevel = 0 
)
virtual

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

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwInt::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
virtual
virtual const char* DtRwInt::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.

virtual DtString DtRwInt::prettyPrint ( ) const
virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

Member Data Documentation

int DtRwInt::myValue
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)