Inheritance diagram for DtModelSet:

Public Member Functions
	DtModelSet ()

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

virtual	~DtModelSet ()

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

virtual DtModelSet &	operator= (const DtModelSet &orig)

virtual DtModelSet *	clone (DtReaderWriterRegistry *parentRegistry=nullptr)

virtual bool	load (const DtFilename &, std::set< DtString > *iconLists=0)

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

virtual void	setComment (const DtString &)

virtual const DtString	comment () const

DtObjectType	objectTypeFor (const DtString &label) const

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

virtual void	emptyList ()

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

int	version () const

virtual DtString	createUniqueID (const DtModelSetEntry *) const

virtual DtString	createUniqueID (const DtString &) const

virtual DtModelSetEntry *	removeModel (const DtObjectType &)

virtual DtModelSetEntry *	removeModel (const DtModelSetEntry *e)

virtual void	loadFromDataFiles (const std::string &directory, const SearchPaths &paths, std::set< DtString > *iconLists=0, bool parallelLoad=false)

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

virtual void	loadEntityFiles (const std::string &, const SearchPaths &paths, std::set< DtString > *iconLists=0, bool parallelLoad=false)

virtual void	loadSimulationObjectGroupFiles (const std::string &, std::set< DtString > *iconLists=0)

virtual const DtObjectType &	nextAvailableSimulationObjectGroupObjectType () const

virtual const DtObjectType &	nextAvailableRandomizedObjectObjectType () const

virtual DtSimulationObjectGroupModelSetEntry	findSimulationObjectGroup (const DtString &sogName) const

virtual void	createEntriesFromFile (const DtFilename &entityFile, const SearchPaths &paths, std::set< DtString > *iconLists)

Public Member Functions inherited from DtRwList
	DtRwList ()

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

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

virtual	~DtRwList ()

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset ()

virtual const char *	readerWriterType () const

bool	operator== (const DtRwList &rhs) const

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)

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

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)

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

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	postGetSelf ()

virtual void	preGetSelf ()

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 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 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	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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 DtModelSet *	create (const DtString &, DtReaderWriterRegistry *const parentRegistry=NULL)


static DtModelSetCreatorFcn	SetModelSetCreatorFcn (DtModelSetCreatorFcn)

static DtModelSetCreatorFcn	ModelSetCreatorFcn ()

static DtModelSet *	Create (const DtString &name="model-set", DtReaderWriterRegistry *parentRegistry=nullptr)

Static Public Member Functions inherited from DtRwList
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 Types
typedef boost::unordered_map < DtString, DtModelSetEntry * >	FastMap

typedef std::map< std::string, DtModelSetEntry * >	EntriesByFile

Protected Member Functions
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

void	copyList (const DtModelSet &orig)

void	clear ()

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

virtual void	addCategoriesFrom (DtModelSetEntry *)

virtual void	updateNextSimulationObjectGroupObjectType (DtSimulationObjectGroupModelSetEntry *)

virtual void	updateNextRandomizedObjectObjectType (DtModelSetEntry *)

virtual void	addIconListsToIconList (const DtModelSetEntry *, std::set< DtString > &iconLists) const

virtual void *	remove (DtReaderWriter , DtListItem )

Protected Member Functions inherited from DtRwList
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtString	myFilename

DtString	myComment

DtRwInt	myVersion

std::set< DtString >	myCategories

FastMap	myFastMap

DtObjectType	myNextSimulationObjectGroupObjectType

DtObjectType	myNextRandomizedObjectObjectType

EntriesByFile	myEntriesByFile

tbb::spin_rw_mutex	myLoadMutex

tbb::spin_rw_mutex	myAddRemoveMutex

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

Static Protected Attributes
static DtModelSetCreatorFcn	theModelSetCreatorFcn

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

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

Member Typedef Documentation

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

protected

typedef std::map<std::string, DtModelSetEntry*> DtModelSet::EntriesByFile

protected

Only used when loading files.

Constructor & Destructor Documentation

DtModelSet::DtModelSet ( )

default constructor

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

virtual DtModelSet::~DtModelSet ( )

virtual

destructor

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

copy constructor

Member Function Documentation

virtual DtModelSet& DtModelSet::operator= ( const DtModelSet & orig )

virtual

assignment operator

virtual DtModelSet* DtModelSet::clone ( DtReaderWriterRegistry * parentRegistry = nullptr )

virtual

static DtModelSetCreatorFcn DtModelSet::SetModelSetCreatorFcn ( DtModelSetCreatorFcn )

static

Factory creator methods call to set and create a DtModelSet.

static DtModelSetCreatorFcn DtModelSet::ModelSetCreatorFcn ( )

static

Factory creator methods call to set and create a DtModelSet.

static DtModelSet* DtModelSet::Create	(	const DtString &	name = `"model-set"`,
		DtReaderWriterRegistry *	parentRegistry = `nullptr`
	)

static

Factory creator methods call to set and create a DtModelSet.

virtual bool DtModelSet::load	(	const DtFilename &	,
		std::set< DtString > *	iconLists = `0`
	)

virtual

Icon lists will contain the list of icons that can be displayed.

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::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,
		const SearchPaths &	paths,
		std::set< DtString > *	iconLists = `0`,
		bool	parallelLoad = `false`
	)

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. Icon lists will contain the icon lists that can be displayed.

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 void DtModelSet::loadEntityFiles	(	const std::string &	,
		const SearchPaths &	paths,
		std::set< DtString > *	iconLists = `0`,
		bool	parallelLoad = `false`
	)

virtual

Loads files of type .entity from given directory.

virtual void DtModelSet::loadSimulationObjectGroupFiles	(	const std::string &	,
		std::set< DtString > *	iconLists = `0`
	)

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 void DtModelSet::createEntriesFromFile	(	const DtFilename &	entityFile,
		const SearchPaths &	paths,
		std::set< DtString > *	iconLists
	)

virtual

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

virtual void DtModelSet::addIconListsToIconList	(	const DtModelSetEntry *	,
		std::set< DtString > &	iconLists
	)		const

protectedvirtual

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

protectedvirtual

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

Reimplemented from DtRwList.

Member Data Documentation

DtString DtModelSet::myFilename

protected

DtString DtModelSet::myComment

protected

DtRwInt DtModelSet::myVersion

protected

Referenced by version().

std::set<DtString> DtModelSet::myCategories

protected

FastMap DtModelSet::myFastMap

protected

DtObjectType DtModelSet::myNextSimulationObjectGroupObjectType

protected

DtObjectType DtModelSet::myNextRandomizedObjectObjectType

protected

DtModelSetCreatorFcn DtModelSet::theModelSetCreatorFcn

staticprotected

EntriesByFile DtModelSet::myEntriesByFile

protected

tbb::spin_rw_mutex DtModelSet::myLoadMutex

mutableprotected

tbb::spin_rw_mutex DtModelSet::myAddRemoveMutex

mutableprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/modelSet.h

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation