Instances of DtMtlParameterDbFileEntry are data records used in MTL parameter database files (*.opd), the file format used by default in VR-Forces to store parameter data. More...

Inheritance diagram for DtMtlParameterDbFileEntry:

[legend]

Public Member Functions
	DtMtlParameterDbFileEntry ()
	DtMtlParameterDbFileEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0, bool readonly=false)
	constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtMtlParameterDbFileEntry (const DtString &name, const DtMtlParameterDbFileEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtMtlParameterDbFileEntry &	operator= (const DtMtlParameterDbFileEntry &orig)
	assignment operrator
virtual	~DtMtlParameterDbFileEntry ()
	destructor

virtual void	setObjectType (const DtObjectType &objectType)
	Accessor/mutator for myObjectType.
virtual const DtObjectType &	objectType () const
	Accessor/mutator for myObjectType.

virtual void	setFilename (const DtFilename &filename)
	Accessor/mutator for myFilename.
virtual DtFilename	filename () const
	Accessor/mutator for myFilename.

virtual void	setParameters (DtVrfObjectParameters *parameters)
	Actual parameter data (associated with the filename).
virtual DtVrfObjectParameters *	parameters () const
	Actual parameter data (associated with the filename).
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.

Protected Attributes
DtVrfObjectParameters *	myParameters
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myObjectType
	Parameter Name: object-type Parameter Description: DIS/RPR object type of the parameter entry (extended DIS enumeration).
DtRwString	myFilename
	Parameter Name: filename Parameter Description: Filename of the object parameter entry file (*.ope) containing the DtVrfObjectParameter data associated with the entry.
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 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.
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

Instances of DtMtlParameterDbFileEntry are data records used in MTL parameter database files (*.opd), the file format used by default in VR-Forces to store parameter data.

Constructor & Destructor Documentation

DtMtlParameterDbFileEntry::DtMtlParameterDbFileEntry ( )

DtMtlParameterDbFileEntry::DtMtlParameterDbFileEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `0`,
		bool	readonly = `false`
	)

constructor Setting the readonly flag prevents object from writing itself to the stream.

By default, DtReaderWriter objects are read/write.

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

copy constructor

virtual DtMtlParameterDbFileEntry::~DtMtlParameterDbFileEntry ( )

virtual

destructor

Member Function Documentation

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

assignment operrator

virtual void DtMtlParameterDbFileEntry::setObjectType ( const DtObjectType & objectType )

virtual

Accessor/mutator for myObjectType.

virtual const DtObjectType& DtMtlParameterDbFileEntry::objectType ( ) const

virtual

Accessor/mutator for myObjectType.

virtual void DtMtlParameterDbFileEntry::setFilename ( const DtFilename & filename )

virtual

Accessor/mutator for myFilename.

virtual DtFilename DtMtlParameterDbFileEntry::filename ( ) const

virtual

Accessor/mutator for myFilename.

virtual void DtMtlParameterDbFileEntry::setParameters ( DtVrfObjectParameters * parameters )

virtual

Actual parameter data (associated with the filename).

virtual DtVrfObjectParameters* DtMtlParameterDbFileEntry::parameters ( ) const

virtual

Actual parameter data (associated with the filename).

Member Data Documentation

DtRwObjectType DtMtlParameterDbFileEntry::myObjectType

protected

Parameter Name: object-type
Parameter Description: DIS/RPR object type of the parameter entry (extended DIS enumeration).

Parameter Default Value:

DtRwString DtMtlParameterDbFileEntry::myFilename

protected

Parameter Name: filename
Parameter Description: Filename of the object parameter entry file (*.ope) containing the DtVrfObjectParameter data associated with the entry.

Parameter Default Value:

DtVrfObjectParameters* DtMtlParameterDbFileEntry::myParameters

protected

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation