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.

Inheritance diagram for DtMtlParameterDbFileEntry:

[legend]

Public Member Functions
	DtMtlParameterDbFileEntry ()

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

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

const DtMtlParameterDbFileEntry &	operator= (const DtMtlParameterDbFileEntry &orig)

virtual	~DtMtlParameterDbFileEntry ()

void	setTypeIsMatchType (bool typeIsMatchType)

bool	typeIsMatchType () const


virtual void	setObjectType (const DtObjectType &objectType)

virtual const DtObjectType &	objectType () const


virtual void	setFilename (const DtFilename &filename)

virtual DtFilename	filename () const


virtual void	setParameters (DtVrfObjectParameters *parameters)

virtual DtVrfObjectParameters *	parameters () const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
bool	myTypeIsMatchType

DtVrfObjectParameters *	myParameters

parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myObjectType

DtRwString	myFilename

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

bool	myInvalid

bool	myChangedFlag

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

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 char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

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)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

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).

void DtMtlParameterDbFileEntry::setTypeIsMatchType ( bool typeIsMatchType )

bool DtMtlParameterDbFileEntry::typeIsMatchType ( ) const

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:
.

bool DtMtlParameterDbFileEntry::myTypeIsMatchType

protected

DtVrfObjectParameters* DtMtlParameterDbFileEntry::myParameters

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/mtlParameterDbFileEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation