Base class for RW objects that describe a system parameter. More...

Inheritance diagram for DtSystemParameterData:

Public Member Functions
	DtSystemParameterData (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSystemParameterData (const DtString &name, const DtSystemParameterData &orig, DtReaderWriterRegistry *parentRegistry=0)
DtSystemParameterData &	operator= (const DtSystemParameterData &orig)
virtual	~DtSystemParameterData ()
virtual DtString	parameterType () const =0
virtual DtSystemParameterData *	clone () const =0
virtual DtString	parameterName () const
virtual void	setParameterName (const DtString &name)
virtual DtString	variableType () const
virtual void	setVariableType (const DtString &type)
virtual DtString	displayLabel () const
virtual void	setDisplayLabel (const DtString &label)
virtual DtString	displayUnits () const
virtual void	setDisplayUnits (const DtString &units)
virtual DtString	sourceUnits () const
virtual void	setSourceUnits (const DtString &units)
virtual void	assignDefaultValueToReaderWriter (DtReaderWriter *rwToChange) const
	If this parameter data has a default value, this method will change the value of the supplied reader-writer to that default value.
bool	operator== (const DtSystemParameterData &) const
	Equivalence operator.
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 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 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.

Static Public Member Functions
static DtSystemParameterData *	createSystemParamterData (const DtString &type)
	Uses theFactory to create a DtSystemParamterData subclass of the specified type.
static DtSystemParameterDataFactory *	factory ()
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 ()

Protected Attributes
DtRwString	myParameterName
DtRwString	myVariableType
DtRwString	myDisplayLabel
DtRwString	myDisplayUnits
DtRwString	mySourceUnits
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.

Static Protected Attributes
static std::auto_ptr < DtSystemParameterDataFactory >	theFactory
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

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 )()
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 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)
	Deriving class overrides these to get/put class specific data.

Detailed Description

Base class for RW objects that describe a system parameter.

This data is used by the entity editor to provide the user the ability to edit parameters of the system. It is part of the system meta data.

Constructor & Destructor Documentation

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

DtSystemParameterData::DtSystemParameterData	(	const DtString &	name,
		const DtSystemParameterData &	orig,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

virtual DtSystemParameterData::~DtSystemParameterData ( )

virtual

Member Function Documentation

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

virtual DtString DtSystemParameterData::parameterType ( ) const

pure virtual

Returns: The type string for this parameter. Comes from systemParameterDataTypes.h.

Implemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtSystemVectorParameterData, and DtSystemArtPartParameterData.

virtual DtSystemParameterData* DtSystemParameterData::clone ( ) const

pure virtual

Implemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, DtSystemVectorParameterData, and DtSystemArtPartParameterData.

virtual DtString DtSystemParameterData::parameterName ( ) const

virtual

virtual void DtSystemParameterData::setParameterName ( const DtString & name )

virtual

virtual DtString DtSystemParameterData::variableType ( ) const

virtual

virtual void DtSystemParameterData::setVariableType ( const DtString & type )

virtual

virtual DtString DtSystemParameterData::displayLabel ( ) const

virtual

virtual void DtSystemParameterData::setDisplayLabel ( const DtString & label )

virtual

virtual DtString DtSystemParameterData::displayUnits ( ) const

virtual

virtual void DtSystemParameterData::setDisplayUnits ( const DtString & units )

virtual

virtual DtString DtSystemParameterData::sourceUnits ( ) const

virtual

virtual void DtSystemParameterData::setSourceUnits ( const DtString & units )

virtual

virtual void DtSystemParameterData::assignDefaultValueToReaderWriter ( DtReaderWriter * rwToChange ) const

virtual

If this parameter data has a default value, this method will change the value of the supplied reader-writer to that default value.

Must be implemented by subclasses that have a default value.

Reimplemented in DtSystemBoolParameterData, DtSystemRealParameterData, DtSystemIntParameterData, DtSystemOrientationParameterData, and DtSystemVectorParameterData.

static DtSystemParameterData* DtSystemParameterData::createSystemParamterData ( const DtString & type )

static

Uses theFactory to create a DtSystemParamterData subclass of the specified type.

static DtSystemParameterDataFactory* DtSystemParameterData::factory ( )

static

Returns: A pointer to the factory used to create subclasses of DtSystemParamterData.

Reimplemented from DtReaderWriter.

bool DtSystemParameterData::operator== ( const DtSystemParameterData & ) const

Equivalence operator.

Member Data Documentation

DtRwString DtSystemParameterData::myParameterName

protected

DtRwString DtSystemParameterData::myVariableType

protected

DtRwString DtSystemParameterData::myDisplayLabel

protected

DtRwString DtSystemParameterData::myDisplayUnits

protected

DtRwString DtSystemParameterData::mySourceUnits

protected

std::auto_ptr<DtSystemParameterDataFactory> DtSystemParameterData::theFactory

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/systemParameterData.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation