DtRwVisualMetaData Class Reference

DtRwVisualMetaData is a container for a visual meta data file, and, with the meta data within that file, additional rules to apply for how to initially set the visual meta data from categories and values. If there is only a file and no rules it is assume that each meta data entry will be selected from a weighted random.

Inheritance diagram for DtRwVisualMetaData:

Public Types
typedef DtRwTemplatedListPtr < DtRwVisualMetaDataEntry, true >	VisualMetaDataList
typedef std::map< DtString, DtRwVisualMetaDataEntry * >	VisualMetaDataMap
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 )()

Public Member Functions
	DtRwVisualMetaData (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaData (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaData (const DtRwVisualMetaData &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaData (const DtString &name, const DtRwVisualMetaData &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaData (const DtSymbolString &name, const DtRwVisualMetaData &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtRwVisualMetaData &	operator= (const DtRwVisualMetaData &orig)
bool	operator== (const DtRwVisualMetaData &orig) const
bool	operator!= (const DtRwVisualMetaData &orig) const
virtual	~DtRwVisualMetaData ()
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual void	clear ()
virtual void	setVisualMetaDataFilename (const DtString &)
const DtString &	visualMetaDataFilename () const
const VisualMetaDataList &	visualMetaData () const
virtual void	postGetSelf ()
virtual bool	removeVisualMetaData (const DtString &)
virtual DtRwVisualMetaDataEntry *	addVisualMetaData (const DtRwVisualMetaDataEntry &)
virtual bool	hasVisualMetaData (const DtString &) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	setSelectionMethodology (const DtString &marking, DtRwVisualMetaDataEntry::SelectionMethodology)
virtual DtRwVisualMetaDataEntry::SelectionMethodology	selectionMethodology (const DtString &) const
virtual void	clearSelections (const DtString &)
virtual void	setSelection (const DtString &, const DtString &)
virtual void	setSelections (const DtString &, const DtRwNLengthStringVector &)
virtual DtRwNLengthStringVector	selections (const DtString &) const
virtual void	setTopWeightedPercent (const DtString &, double)
virtual double	topWeightedPercent (const DtString &) const
virtual void	setTopWeightedRandomChance (const DtString &, double)
virtual double	topWeightedRandomChance (const DtString &) 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)
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	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 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	wasUpdatedSince (DtTime t) 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	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static const char *	theXmlType ()
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 Attributes
DtRwString	myVisualMetaDataFilename
VisualMetaDataList	myVisualMetaDataList
VisualMetaDataMap	myVisualMetaDataMap
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
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

Member Typedef Documentation

typedef DtRwTemplatedListPtr<DtRwVisualMetaDataEntry, true> DtRwVisualMetaData::VisualMetaDataList

typedef std::map<DtString, DtRwVisualMetaDataEntry*> DtRwVisualMetaData::VisualMetaDataMap

Constructor & Destructor Documentation

DtRwVisualMetaData::DtRwVisualMetaData	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtRwVisualMetaData::DtRwVisualMetaData	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtRwVisualMetaData::DtRwVisualMetaData	(	const DtRwVisualMetaData &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

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

DtRwVisualMetaData::DtRwVisualMetaData	(	const DtSymbolString &	name,
		const DtRwVisualMetaData &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

virtual DtRwVisualMetaData::~DtRwVisualMetaData ( )

virtual

Member Function Documentation

const DtRwVisualMetaData& DtRwVisualMetaData::operator=

(

const DtRwVisualMetaData &

orig

)

bool DtRwVisualMetaData::operator==

(

const DtRwVisualMetaData &

orig

)

const

comparison operator

bool DtRwVisualMetaData::operator!= ( const DtRwVisualMetaData &  orig ) const

inline

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

static const char* DtRwVisualMetaData::theXmlType ( )

static

The type that is used when archiving to an XML stream.

virtual const char* DtRwVisualMetaData::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwVisualMetaData::clear ( )

virtual

virtual void DtRwVisualMetaData::setVisualMetaDataFilename ( const DtString &  )

virtual

Accessor/mutator for myVisualMetaDataFilename.

const DtString& DtRwVisualMetaData::visualMetaDataFilename ( ) const

inline

const VisualMetaDataList& DtRwVisualMetaData::visualMetaData ( ) const

inline

Accessor for #myVisualDataMap.

virtual void DtRwVisualMetaData::postGetSelf ( )

virtual

Creates internal map of entries.

Reimplemented from DtReaderWriter.

virtual bool DtRwVisualMetaData::removeVisualMetaData ( const DtString &  )

virtual

virtual DtRwVisualMetaDataEntry* DtRwVisualMetaData::addVisualMetaData ( const DtRwVisualMetaDataEntry &  )

virtual

Adds a clone and returns the new member.

virtual bool DtRwVisualMetaData::hasVisualMetaData ( const DtString &  ) const

virtual

Returns true if the meta data entry exists.

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

virtual

Gets data from the environment value.

Reimplemented from DtReaderWriter.

virtual void DtRwVisualMetaData::setSelectionMethodology ( const DtString &  marking, DtRwVisualMetaDataEntry::SelectionMethodology    )

virtual

Given the marking for the meta data, set the selection methodology to that.

virtual DtRwVisualMetaDataEntry::SelectionMethodology DtRwVisualMetaData::selectionMethodology ( const DtString &  ) const

virtual

virtual void DtRwVisualMetaData::clearSelections ( const DtString &  )

virtual

Given the annotation clear the selections that might have been randomly set.

virtual void DtRwVisualMetaData::setSelection ( const DtString &  , const DtString &    )

virtual

Set the only random selection to the given selection.

virtual void DtRwVisualMetaData::setSelections ( const DtString &  , const DtRwNLengthStringVector &    )

virtual

Sets the random selections to the given list.

virtual DtRwNLengthStringVector DtRwVisualMetaData::selections ( const DtString &  ) const

virtual

Returns the random selections.

virtual void DtRwVisualMetaData::setTopWeightedPercent ( const DtString &  , double    )

virtual

Accessor/mutator for the top percentage for weighted random selection.

virtual double DtRwVisualMetaData::topWeightedPercent ( const DtString &  ) const

virtual

virtual void DtRwVisualMetaData::setTopWeightedRandomChance ( const DtString &  , double    )

virtual

Accessor/mutator for the random percentage chance of selecting one of the top weighted items.

virtual double DtRwVisualMetaData::topWeightedRandomChance ( const DtString &  ) const

virtual

Member Data Documentation

DtRwString DtRwVisualMetaData::myVisualMetaDataFilename

protected

The filename that points to the meta data for this object. That can be used to read and parse the visual meta data and possible values.

VisualMetaDataList DtRwVisualMetaData::myVisualMetaDataList

protected

Contains the reader/writer list of visual meta data.

VisualMetaDataMap DtRwVisualMetaData::myVisualMetaDataMap

protected

Internal faster access map of the entries.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/rwVisualMetaData.h