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

Inheritance diagram for DtRwVisualMetaDataEntry:

Public Types
enum	SelectionMethodology {   Default = 0, Specific = 1, Weighted = 2, Random = 3,   WeightedExponential = 4 }
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
	comparison operator
bool	operator!= (const DtRwVisualMetaDataEntry &orig) const
virtual	~DtRwVisualMetaDataEntry ()
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual void	clear ()
virtual void	setSelectionMethodology (SelectionMethodology)
	Accessor/mutator for mySelectionMethodology.
SelectionMethodology	selectionMethodology () const
const DtRwNLengthStringVector &	selections () const
	Accessor for mySelections.
virtual void	setSelections (const DtRwNLengthStringVector &)
DtRwNLengthStringVector &	selections ()
virtual void	setTopWeightedPercent (double)
	Accessor/mutator for the myTopWeightedPercent.
virtual double	topWeightedPercent () const
virtual void	setTopWeightedRandomChance (double)
	Accessor/mutator for the myTopWeightedRandomChance.
virtual double	topWeightedRandomChance () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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 (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called.
virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual DtRwVariableBindings *	generateVariableBindings () const
	Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class.
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
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)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.

Protected Attributes
DtRwInt	mySelectionMethodology
	The methodology used for the section: 0 - Model default 1 - Specific entry 2 - Weighted average.
DtRwNLengthStringVector	mySelections
	The list of values that can be selected from. If empty will consider all values as valid.
DtRwReal	myTopWeightedPercent
	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.
DtRwReal	myTopWeightedRandomChance
	The percentage chance that a top weighted item is selected.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked.

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

Detailed Description

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

Member Enumeration Documentation

enum DtRwVisualMetaDataEntry::SelectionMethodology

Enumerator:

Default
Specific
Weighted
Random
WeightedExponential

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.

Reimplemented from DtReaderWriter.

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.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/rwVisualMetaDataEntry.h