Instances of DtVrfStateRepositoryUserExtension can be used by customers to extend the base DtVrfObjectStateRepository class, as an alternative to extending multiple leaf-level classes in the DtVrfObjectStateRepsository hierarchy. More...

Inheritance diagram for DtVrfStateRepositoryUserExtension:

[legend]

Public Member Functions
	DtVrfStateRepositoryUserExtension (DtVrfObjectStateRepository stateRepository, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	constructor
	DtVrfStateRepositoryUserExtension (DtVrfObjectStateRepository stateRepository, const DtVrfStateRepositoryUserExtension &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	copy constructor
const DtVrfStateRepositoryUserExtension &	operator= (const DtVrfStateRepositoryUserExtension &orig)
	assignment
virtual	~DtVrfStateRepositoryUserExtension ()
	destructor
virtual DtVrfStateRepositoryUserExtension *	clone (DtVrfObjectStateRepository stateRepository, const DtString &name, DtReaderWriterRegistry parentRegistry=NULL) const
	Note you must implement the clone function in derived classes to ensure that this data is initialized from the parameter database correctly.
virtual DtString	type () const
	Type of extension object to create.
virtual void	init ()
	Called after object has been created by the DtVrfObjectStateRepository class.
virtual DtVrfObjectStateRepository *	stateRepository () const
	State repository this object belongs to.
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 DtVrfStateRepositoryUserExtension *	create (DtVrfObjectStateRepository stateRepository, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)
	Returns newly created instance of this class.
static void	setFactory (DtVrfStateRepositoryUserExtensionFactory *factory)
static DtVrfStateRepositoryUserExtensionFactory *	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
DtVrfObjectStateRepository *	myStateRepository
	Reference to the state repository we belong to.
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 DtVrfStateRepositoryUserExtensionFactory *	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

Instances of DtVrfStateRepositoryUserExtension can be used by customers to extend the base DtVrfObjectStateRepository class, as an alternative to extending multiple leaf-level classes in the DtVrfObjectStateRepsository hierarchy.

Examples

State Repository Extension Example

Constructor & Destructor Documentation

DtVrfStateRepositoryUserExtension::DtVrfStateRepositoryUserExtension	(	DtVrfObjectStateRepository *	stateRepository,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

constructor

DtVrfStateRepositoryUserExtension::DtVrfStateRepositoryUserExtension	(	DtVrfObjectStateRepository *	stateRepository,
		const DtVrfStateRepositoryUserExtension &	orig,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

copy constructor

virtual DtVrfStateRepositoryUserExtension::~DtVrfStateRepositoryUserExtension ( )

virtual

destructor

Member Function Documentation

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

assignment

virtual DtVrfStateRepositoryUserExtension* DtVrfStateRepositoryUserExtension::clone	(	DtVrfObjectStateRepository *	stateRepository,
		const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)		const

virtual

Note you must implement the clone function in derived classes to ensure that this data is initialized from the parameter database correctly.

Reimplemented in DerivedSRUserExtension.

virtual DtString DtVrfStateRepositoryUserExtension::type ( ) const

virtual

Type of extension object to create.

Returns DtDefaultSRUserExtensionType, defined in vrfSRUserExtTypes.h.

Reimplemented in DerivedSRUserExtension.

virtual void DtVrfStateRepositoryUserExtension::init ( void )

inlinevirtual

Called after object has been created by the DtVrfObjectStateRepository class.

Reimplemented in DerivedSRUserExtension.

virtual DtVrfObjectStateRepository* DtVrfStateRepositoryUserExtension::stateRepository ( ) const

virtual

State repository this object belongs to.

static DtVrfStateRepositoryUserExtension* DtVrfStateRepositoryUserExtension::create	(	DtVrfObjectStateRepository *	stateRepository,
		const DtString &	rwName = `DtString::nullString()`,
		DtReaderWriterRegistry *	parentRegistry = `0`
	)

static

Returns newly created instance of this class.

Reimplemented in DerivedSRUserExtension.

static void DtVrfStateRepositoryUserExtension::setFactory ( DtVrfStateRepositoryUserExtensionFactory * factory )

static

static DtVrfStateRepositoryUserExtensionFactory* DtVrfStateRepositoryUserExtension::factory ( )

static

Returns: A pointer to the static DtReaderWriterFactory. This factory can create instances of DtReaderWriter subclasses that have been registered with it.

Reimplemented from DtReaderWriter.

Member Data Documentation

DtVrfObjectStateRepository* DtVrfStateRepositoryUserExtension::myStateRepository

protected

Reference to the state repository we belong to.

DtVrfStateRepositoryUserExtensionFactory* DtVrfStateRepositoryUserExtension::theFactory

staticprotected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/vrfSRUserExt.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