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

Inheritance diagram for DtRwVisualMetaData:

[legend]

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

bool	operator!= (const DtRwVisualMetaData &orig) const

virtual	~DtRwVisualMetaData ()

virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is. More...

virtual const char *	xmlType () const

virtual void	clear ()

virtual void	setVisualMetaDataFilename (const DtString &)
	Accessor/mutator for myVisualMetaDataFilename. More...

const DtString &	visualMetaDataFilename () const

const VisualMetaDataList &	visualMetaData () const
	Accessor for #myVisualDataMap. More...

virtual void	postGetSelf ()
	Creates internal map of entries. More...

virtual bool	removeVisualMetaData (const DtString &)

virtual DtRwVisualMetaDataEntry *	addVisualMetaData (const DtRwVisualMetaDataEntry &)
	Adds a clone and returns the new member. More...

virtual bool	hasVisualMetaData (const DtString &) const
	Returns true if the meta data entry exists. More...

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value. More...

virtual void	setSelectionMethodology (const DtString &marking, DtRwVisualMetaDataEntry::SelectionMethodology)
	Given the marking for the meta data, set the selection methodology to that. More...

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

virtual void	clearSelections (const DtString &)
	Given the annotation clear the selections that might have been randomly set. More...

virtual void	setSelection (const DtString &, const DtString &)
	Set the only random selection to the given selection. More...

virtual void	setSelections (const DtString &, const DtRwNLengthStringVector &)
	Sets the random selections to the given list. More...

virtual DtRwNLengthStringVector	selections (const DtString &) const
	Returns the random selections. More...

virtual void	setTopWeightedPercent (const DtString &, double)
	Accessor/mutator for the top percentage for weighted random selection. More...

virtual double	topWeightedPercent (const DtString &) const

virtual void	setTopWeightedRandomChance (const DtString &, double)
	Accessor/mutator for the random percentage chance of selecting one of the top weighted items. More...

virtual double	topWeightedRandomChance (const DtString &) const

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor More...

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream. More...

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

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor More...

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor More...

const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator More...

bool	operator== (const DtReaderWriter &) const
	Equivalence operator. More...

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()
	destructor More...

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

virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op. More...

virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op. More...

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream. More...

virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op. More...

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

virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object. More...

virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object. More...

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

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

virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment. More...

virtual bool	variableIsBound () const

virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false. More...

virtual void	setName (const DtString &)
	Set the name of the object. More...

virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable. More...

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children. More...

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

virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference. More...

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

virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated. More...

virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time. More...

virtual bool	changedSinceLastChecked ()
	Returns true if this objects value has changed since the last time this function was called. More...

virtual bool	peekChangedSinceLastChecked () const
	Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More...

virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data. More...

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

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere. More...

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively. More...

virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference. More...

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

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More...

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

const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object. More...

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

virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename. More...

virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid. More...

virtual bool	fromXmlFile (const DtFilename &)
	Restores object from given xml file. More...

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data. More...

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference. More...

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)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More...

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference. More...

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream. More...

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 ()
	The type that is used when archiving to an XML stream. More...

static const DtFilename &	appPath ()
	Gets the current working directory. More...

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory. More...

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

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within. More...

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	Given a xml environment, returns a newly created reader/writer object from the object found within. More...

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP. More...

Protected Attributes
DtRwString	myVisualMetaDataFilename
	The filename that points to the meta data for this object. More...

VisualMetaDataList	myVisualMetaDataList
	Contains the reader/writer list of visual meta data. More...

VisualMetaDataMap	myVisualMetaDataMap
	Internal faster access map of the entries. More...

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

bool	myInvalid
	Set to true if there is a problem reading this item. More...

bool	myChangedFlag
	Set to true when value changes Set to false when value checked with changedSinceLastChecked. More...

Additional Inherited Members
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter. More...

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

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

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.vrf4-10-branch/include/vrfutil/rwVisualMetaData.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation