DtRwClockTime Class Reference

class DtRwClockTime: More...

Inheritance diagram for DtRwClockTime:

Public Member Functions
	DtRwClockTime ()
	default constructor
	DtRwClockTime (const DtString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtRwClockTime (const DtSymbolString &name, DtReaderWriterRegistry *const parentRegistry=NULL)
	DtRwClockTime (const DtString &name, int days, int hours, int minutes, double seconds, DtReaderWriterRegistry *const parentRegistry=NULL)
	real constructor
	DtRwClockTime (const DtSymbolString &name, int days, int hours, int minutes, double seconds, DtReaderWriterRegistry *const parentRegistry=NULL)
virtual	~DtRwClockTime ()
	destructor
	DtRwClockTime (const DtRwClockTime &orig)
	copy constructor
DtRwClockTime &	operator= (const DtRwClockTime &orig)
	assignment operator
virtual void	setDays (int days)
	Set/get days field.
virtual int	days () const
virtual void	setHours (int hours)
	Set/get hour field.
virtual int	hours () const
virtual void	setMinutes (int minutes)
	Set/get minute field.
virtual int	minutes () const
virtual void	setSeconds (double seconds)
	Set/get seconds field.
virtual double	seconds () const
virtual double	timeInSeconds () const
	Get overall time in seconds (taking into account days, hours, minutes, and seconds fields).
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.
bool	operator== (const DtRwClockTime &) const
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 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 (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 aliasContainer &	aliases () 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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Protected Attributes
int	myDays
int	myHours
int	myMinutes
double	mySeconds
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 DtReaderWriterFactory *	factory ()
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 DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

class DtRwClockTime:

Instances of DtRwClockTime are

Constructor & Destructor Documentation

DtRwClockTime::DtRwClockTime

(

)

default constructor

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

real constructor

DtRwClockTime::DtRwClockTime	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

DtRwClockTime::DtRwClockTime	(	const DtString &	name,
		int	days,
		int	hours,
		int	minutes,
		double	seconds,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

real constructor

DtRwClockTime::DtRwClockTime	(	const DtSymbolString &	name,
		int	days,
		int	hours,
		int	minutes,
		double	seconds,
		DtReaderWriterRegistry *const	parentRegistry = NULL
	)

virtual DtRwClockTime::~DtRwClockTime ( )

virtual

destructor

DtRwClockTime::DtRwClockTime

(

const DtRwClockTime &

orig

)

copy constructor

Member Function Documentation

DtRwClockTime& DtRwClockTime::operator=

(

const DtRwClockTime &

orig

)

assignment operator

virtual void DtRwClockTime::setDays ( int  days )

virtual

Set/get days field.

virtual int DtRwClockTime::days ( ) const

virtual

virtual void DtRwClockTime::setHours ( int  hours )

virtual

Set/get hour field.

virtual int DtRwClockTime::hours ( ) const

virtual

virtual void DtRwClockTime::setMinutes ( int  minutes )

virtual

Set/get minute field.

virtual int DtRwClockTime::minutes ( ) const

virtual

virtual void DtRwClockTime::setSeconds ( double  seconds )

virtual

Set/get seconds field.

virtual double DtRwClockTime::seconds ( ) const

virtual

virtual double DtRwClockTime::timeInSeconds ( ) const

virtual

Get overall time in seconds (taking into account days, hours, minutes, and seconds fields).

virtual void DtRwClockTime::putData ( FILE *  fp, int  indentLevel = 0  )

virtual

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

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtRwClockTime::getData ( DtlObjPtr  args, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

virtual

virtual const char* DtRwClockTime::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.

bool DtRwClockTime::operator==

(

const DtRwClockTime &

)

const

Member Data Documentation

int DtRwClockTime::myDays

protected

int DtRwClockTime::myHours

protected

int DtRwClockTime::myMinutes

protected

double DtRwClockTime::mySeconds

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwClockTime.h