DtRwInt Class Reference

Description: Readable, Writable int. More...

Inheritance diagram for DtRwInt:

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)
DtRwInt &	operator= (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	reset ()
	Resets value to initial clear state.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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.
virtual int	alignment () const
	Return HLA network alignment. sizeof(int)
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
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.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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 void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static int	getIntegerFromHex (DtEnvironmentSP env, const DtString &attributeName, DtEnvValueSP root)
static int	getInt (DtEnvironmentSP env, const DtString &attributeName, DtEnvValueSP root)
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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Protected Attributes
int	myValue
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual const char *	xmlType () const
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

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)
	Copies values from the specified DtReaderWriter.
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

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

virtual void DtRwInt::putData ( DtEnvironmentSP  , DtEnvValueSP  parent  ) const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtReaderWriter.

virtual void DtRwInt::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.

static const char* DtRwInt::theXmlType ( )

static

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

Reimplemented from DtReaderWriter.

Reimplemented in DtRwInt32, DtRwInt16, and DtRwInt8.

Referenced by DtRwInt8::xmlType(), DtRwInt16::xmlType(), and DtRwInt32::xmlType().

virtual const char* DtRwInt::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

Reimplemented in DtRwInt32, DtRwInt16, and DtRwInt8.

References DtReaderWriter::theXmlType().

static int DtRwInt::getIntegerFromHex ( DtEnvironmentSP  env, const DtString &  attributeName, DtEnvValueSP  root  )

static

static int DtRwInt::getInt ( DtEnvironmentSP  env, const DtString &  attributeName, DtEnvValueSP  root  )

static

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::reset ( )

virtual

Resets value to initial clear state.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperty< DtRwInt >, DtRwProperty< DtRwInt8 >, DtRwProperty< DtRwInt16 >, and DtRwProperty< DtRwInt32 >.

virtual void DtRwInt::putData ( std::string &  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 DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Reimplemented from DtReaderWriter.

Reimplemented in DtRwProperty< DtRwInt >, DtRwProperty< DtRwInt8 >, DtRwProperty< DtRwInt16 >, and DtRwProperty< DtRwInt32 >.

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.

Reimplemented in DtRwInt32, DtRwInt16, and DtRwInt8.

virtual DtString DtRwInt::prettyPrint ( ) const

virtual

Routine to return a human readable form of this variable.

Reimplemented from DtReaderWriter.

virtual int DtRwInt::alignment ( ) const

virtual

Return HLA network alignment. sizeof(int)

Reimplemented from DtReaderWriter.

Member Data Documentation

int DtRwInt::myValue

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/readerWriter/rwInt.h