DtModelSet Class Reference

Inheritance diagram for DtModelSet:

Public Member Functions
	DtModelSet ()
	default constructor
	DtModelSet (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtModelSet ()
	destructor
	DtModelSet (const DtModelSet &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtModelSet &	operator= (const DtModelSet &orig)
	assignment operator
virtual bool	load (const DtFilename &)
virtual bool	save (const DtFilename &)
virtual DtModelSetEntry *	find (const DtObjectType &) const
virtual DtModelSetEntry *	findMatchingPattern (const DtObjectType &) const
virtual DtModelSetEntry *	findByUniqueID (const DtString &) const
virtual DtModelSetEntry *	findByLabel (const DtString &) const
virtual void	add (DtModelSetEntry *)
	Adds the new model entry and also adds into the fast map for faster lookup by type for the find() method.
virtual void *	remove (DtReaderWriter *, DtListItem *)
	Removes entry and also removes from the fastMap (if exists)
virtual void	setComment (const DtString &)
virtual const DtString	comment () const
DtObjectType	objectTypeFor (const DtString &label) const
	Returns object type for item matching label.
virtual DtModelSetEntry *	addModel (DtModelSetEntry *, bool clone=true)
	Clones the model and adds it.
virtual void	emptyList ()
virtual void	entitiesForObjectType (const DtObjectType &o, std::list< DtString > &list) const
	Give the object type, return all names that match (including wild cards) that object type.
int	version () const
	Returns an entry given a unique ID.
virtual DtString	createUniqueID (const DtModelSetEntry *) const
	Creates a unique id for the given value.
virtual DtString	createUniqueID (const DtString &) const
virtual DtModelSetEntry *	removeModel (const DtObjectType &)
	Revmoes the given model. Returns the model entry (which can be deleted)
virtual DtModelSetEntry *	removeModel (const DtModelSetEntry *e)
virtual void	loadFromDataFiles (const std::string &directory)
	Given the particular directory, scan for .data files and build the model set directory from those entries.
virtual const std::set < DtString > &	categories () const
	Inclusive categories of all added model set entries.
virtual const std::set < DtString > &	categoriesForPalette (const DtString &pal) const
	Return the categories for a particular palette.
virtual void	loadEntityFiles (const std::string &)
	Loads files of type .entity from given directory.
virtual void	loadSimulationObjectGroupFiles (const std::string &)
	Loads simulation object group files from directory.
virtual const DtObjectType &	nextAvailableSimulationObjectGroupObjectType () const
	Returns the next object type that can be used for the simulaton object group model set entry.
virtual const DtObjectType &	nextAvailableRandomizedObjectObjectType () const
	Returns the next object type that can be used for the randimized object set entry.
virtual DtSimulationObjectGroupModelSetEntry	findSimulationObjectGroup (const DtString &sogName) const
	Returns the entry that has a filename which references the given simulation object group.
Public Member Functions inherited from DtRwList
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter *data, DtReaderWriter *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtReaderWriter *after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual const char *	xmlType () const
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all.
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 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 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 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	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 DtModelSet *	create (const DtString &, DtReaderWriterRegistry *const parentRegistry=NULL)
Static Public Member Functions inherited from DtRwList
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

Protected Types
typedef boost::unordered_map < DtString, DtModelSetEntry * >	FastMap

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Constructs a DtRwString item, and then retrieves it from the stream.
void	copyList (const DtModelSet &orig)
	Non-virtual since it is called by the constructor.
void	clear ()
	Non-virtual since is it called by the constructor/destructor.
virtual void	writeSelf (std::string &fp, int i, bool writeUnspecified, const DtFilename &path)
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual void	addCategoriesFrom (DtModelSetEntry *)
	Adds categories from the given model set entry (if they do not exist)
virtual void	updateNextSimulationObjectGroupObjectType (DtSimulationObjectGroupModelSetEntry *)
virtual void	updateNextRandomizedObjectObjectType (DtModelSetEntry *)
Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter *data, DtListItem *before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, DtListItem *after)
	Add element to the list just after the indicated item.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtString	myFilename
DtString	myComment
DtRwInt	myVersion
std::set< DtString >	myCategories
std::map< DtString, std::set < DtString > >	myCategoriesForPalette
FastMap	myFastMap
DtObjectType	myNextSimulationObjectGroupObjectType
DtObjectType	myNextRandomizedObjectObjectType

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

Member Typedef Documentation

typedef boost::unordered_map<DtString, DtModelSetEntry*> DtModelSet::FastMap

protected

Constructor & Destructor Documentation

DtModelSet::DtModelSet

(

)

default constructor

DtModelSet::DtModelSet	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtModelSet::~DtModelSet ( )

virtual

destructor

DtModelSet::DtModelSet	(	const DtModelSet &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

Member Function Documentation

DtModelSet& DtModelSet::operator=

(

const DtModelSet &

orig

)

assignment operator

virtual bool DtModelSet::load ( const DtFilename &  )

virtual

virtual bool DtModelSet::save ( const DtFilename &  )

virtual

virtual DtModelSetEntry* DtModelSet::find ( const DtObjectType &  ) const

virtual

virtual DtModelSetEntry* DtModelSet::findMatchingPattern ( const DtObjectType &  ) const

virtual

virtual DtModelSetEntry* DtModelSet::findByUniqueID ( const DtString &  ) const

virtual

virtual DtModelSetEntry* DtModelSet::findByLabel ( const DtString &  ) const

virtual

virtual void DtModelSet::add ( DtModelSetEntry *  )

virtual

Adds the new model entry and also adds into the fast map for faster lookup by type for the find() method.

virtual void* DtModelSet::remove ( DtReaderWriter *  , DtListItem *    )

virtual

Removes entry and also removes from the fastMap (if exists)

Reimplemented from DtRwList.

virtual void DtModelSet::setComment ( const DtString &  )

virtual

virtual const DtString DtModelSet::comment ( ) const

virtual

static DtModelSet* DtModelSet::create ( const DtString &  , DtReaderWriterRegistry *const  parentRegistry = NULL  )

static

DtObjectType DtModelSet::objectTypeFor

(

const DtString &

label

)

const

Returns object type for item matching label.

virtual DtModelSetEntry* DtModelSet::addModel ( DtModelSetEntry *  , bool  clone = true  )

virtual

Clones the model and adds it.

Returns the cloned model if clone is true, else returns supplied model. Note that this class will take ownership of the data passed in if not cloned

virtual void DtModelSet::emptyList ( )

virtual

virtual void DtModelSet::entitiesForObjectType ( const DtObjectType &  o, std::list< DtString > &  list  ) const

virtual

Give the object type, return all names that match (including wild cards) that object type.

Will not add the name if it already exists in the list

int DtModelSet::version ( ) const

inline

Returns an entry given a unique ID.

References myVersion.

virtual DtString DtModelSet::createUniqueID ( const DtModelSetEntry *  ) const

virtual

Creates a unique id for the given value.

virtual DtString DtModelSet::createUniqueID ( const DtString &  ) const

virtual

virtual DtModelSetEntry* DtModelSet::removeModel ( const DtObjectType &  )

virtual

Revmoes the given model. Returns the model entry (which can be deleted)

virtual DtModelSetEntry* DtModelSet::removeModel ( const DtModelSetEntry *  e )

virtual

virtual void DtModelSet::loadFromDataFiles ( const std::string &  directory )

virtual

Given the particular directory, scan for .data files and build the model set directory from those entries.

Will append entries to whatever is currently contained

virtual const std::set<DtString>& DtModelSet::categories ( ) const

virtual

Inclusive categories of all added model set entries.

If an entry is removed that is the only member of a particular category that category will still exist in this list

virtual const std::set<DtString>& DtModelSet::categoriesForPalette ( const DtString &  pal ) const

virtual

Return the categories for a particular palette.

virtual void DtModelSet::loadEntityFiles ( const std::string &  )

virtual

Loads files of type .entity from given directory.

virtual void DtModelSet::loadSimulationObjectGroupFiles ( const std::string &  )

virtual

Loads simulation object group files from directory.

virtual const DtObjectType& DtModelSet::nextAvailableSimulationObjectGroupObjectType ( ) const

virtual

Returns the next object type that can be used for the simulaton object group model set entry.

virtual const DtObjectType& DtModelSet::nextAvailableRandomizedObjectObjectType ( ) const

virtual

Returns the next object type that can be used for the randimized object set entry.

virtual DtSimulationObjectGroupModelSetEntry DtModelSet::findSimulationObjectGroup ( const DtString &  sogName ) const

virtual

Returns the entry that has a filename which references the given simulation object group.

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

protectedvirtual

Constructs a DtRwString item, and then retrieves it from the stream.

Implements DtRwList.

void DtModelSet::copyList ( const DtModelSet &  orig )

protected

Non-virtual since it is called by the constructor.

void DtModelSet::clear ( )

protected

Non-virtual since is it called by the constructor/destructor.

virtual void DtModelSet::writeSelf ( std::string &  fp, int  indentLevel, bool  writeUnspecified, const DtFilename &  path  )

protectedvirtual

Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.

Reimplemented from DtReaderWriter.

virtual void DtModelSet::addCategoriesFrom ( DtModelSetEntry *  )

protectedvirtual

Adds categories from the given model set entry (if they do not exist)

virtual void DtModelSet::updateNextSimulationObjectGroupObjectType ( DtSimulationObjectGroupModelSetEntry *  )

protectedvirtual

virtual void DtModelSet::updateNextRandomizedObjectObjectType ( DtModelSetEntry *  )

protectedvirtual

Member Data Documentation

DtString DtModelSet::myFilename

protected

DtString DtModelSet::myComment

protected

DtRwInt DtModelSet::myVersion

protected

Referenced by version().

std::set<DtString> DtModelSet::myCategories

protected

std::map<DtString, std::set<DtString> > DtModelSet::myCategoriesForPalette

protected

FastMap DtModelSet::myFastMap

protected

DtObjectType DtModelSet::myNextSimulationObjectGroupObjectType

protected

DtObjectType DtModelSet::myNextRandomizedObjectObjectType

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/modelSet.h