DtRwVisualMetaDataEntry Class Reference

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

Public Types
enum	SelectionMethodology {   Default = 0, Specific = 1, Weighted = 2, Random = 3,   WeightedExponential = 4, Variant = 5, Subvariant = 6, Unused = 7,   User_Start = 100 }
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
	DtRwVisualMetaDataEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaDataEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaDataEntry (const DtRwVisualMetaDataEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaDataEntry (const DtString &name, const DtRwVisualMetaDataEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
	DtRwVisualMetaDataEntry (const DtSymbolString &name, const DtRwVisualMetaDataEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
const DtRwVisualMetaDataEntry &	operator= (const DtRwVisualMetaDataEntry &orig)
bool	operator== (const DtRwVisualMetaDataEntry &orig) const
bool	operator!= (const DtRwVisualMetaDataEntry &orig) const
virtual	~DtRwVisualMetaDataEntry ()
virtual const char *	readerWriterType () const
virtual const char *	xmlType () const
virtual void	clear ()
virtual void	setSelectionMethodology (SelectionMethodology)
SelectionMethodology	selectionMethodology () const
const DtRwNLengthStringVector &	selections () const
virtual void	setSelections (const DtRwNLengthStringVector &)
DtRwNLengthStringVector &	selections ()
virtual void	setTopWeightedPercent (double)
virtual double	topWeightedPercent () const
virtual void	setTopWeightedRandomChance (double)
virtual double	topWeightedRandomChance () 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 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)

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
DtRwInt	mySelectionMethodology
DtRwNLengthStringVector	mySelections
DtRwReal	myTopWeightedPercent
DtRwReal	myTopWeightedRandomChance
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 Enumeration Documentation

enum DtRwVisualMetaDataEntry::SelectionMethodology

Enumerator
Default
Specific
Weighted
Random
WeightedExponential
Variant
Subvariant
Unused
User_Start

Constructor & Destructor Documentation

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

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

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

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

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

virtual DtRwVisualMetaDataEntry::~DtRwVisualMetaDataEntry ( )

virtual

Member Function Documentation

const DtRwVisualMetaDataEntry& DtRwVisualMetaDataEntry::operator=

(

const DtRwVisualMetaDataEntry &

orig

)

bool DtRwVisualMetaDataEntry::operator==

(

const DtRwVisualMetaDataEntry &

orig

)

const

comparison operator

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

inline

virtual const char* DtRwVisualMetaDataEntry::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* DtRwVisualMetaDataEntry::theXmlType ( )

static

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

virtual const char* DtRwVisualMetaDataEntry::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual void DtRwVisualMetaDataEntry::clear ( )

virtual

virtual void DtRwVisualMetaDataEntry::setSelectionMethodology ( SelectionMethodology  )

virtual

Accessor/mutator for mySelectionMethodology.

SelectionMethodology DtRwVisualMetaDataEntry::selectionMethodology ( ) const

inline

const DtRwNLengthStringVector& DtRwVisualMetaDataEntry::selections ( ) const

inline

Accessor for mySelections.

virtual void DtRwVisualMetaDataEntry::setSelections ( const DtRwNLengthStringVector &  )

virtual

DtRwNLengthStringVector& DtRwVisualMetaDataEntry::selections ( )

inline

virtual void DtRwVisualMetaDataEntry::setTopWeightedPercent ( double  )

virtual

Accessor/mutator for the myTopWeightedPercent.

virtual double DtRwVisualMetaDataEntry::topWeightedPercent ( ) const

virtual

virtual void DtRwVisualMetaDataEntry::setTopWeightedRandomChance ( double  )

virtual

Accessor/mutator for the myTopWeightedRandomChance.

virtual double DtRwVisualMetaDataEntry::topWeightedRandomChance ( ) const

virtual

Member Data Documentation

DtRwInt DtRwVisualMetaDataEntry::mySelectionMethodology

protected

The methodology used for the section: 0 - Model default 1 - Specific entry 2 - Weighted average. This will be the top 20% of the items with an 80% chance of selection and the bottom 80% with a 20% chance of selection 3 - Random selection 4 - Weighted Exponential will use a formula of floor(num_items * pow(random(0 - 1), 2))

DtRwNLengthStringVector DtRwVisualMetaDataEntry::mySelections

protected

The list of values that can be selected from. If empty will consider all values as valid. If this is a subvariant, this is the variant that this will be used as a subvariant of.

DtRwReal DtRwVisualMetaDataEntry::myTopWeightedPercent

protected

The percentage of the total items selected for weighted random selected that are the highest rated to be used in the initial potential selection of items to show. For example, if there are 10 items in a marking that want to be randomly selected from, and this value is 20%, the top 2 items will be used for the initial selection based on the myTopWeightedRandomChance. Default is 17.1875 percent.

DtRwReal DtRwVisualMetaDataEntry::myTopWeightedRandomChance

protected

The percentage chance that a top weighted item is selected. As in the myTopWeightedPercent example, if there are 2 items and this chance is 80 percent, the first item has a 40% chance or selection and the second a 40% chance. The final 8 items each have a 2.5 percent chance of selection. The default is 80 percent.

---

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

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