The schema manager is responsible to managing all of the schemas in the system. More...

Public Types
enum	SchemaTypes { ModelDefinitionSchema, VisualDefinitionSchema }
typedef std::set< int >	PossibleSchemaValues

Public Member Functions
virtual	~DtSchemaManager ()
	DTOR.
virtual void	addSchemaEntry (const makArchives::DtSchemaEntry &schema)
	Add a new model definition schema.
virtual bool	removeSchemaEntry (const std::string &)
	Removes the schema from the specified schema and sends out a schemaRemoved signal.
virtual makArchives::DtSchemaEntry *	findSchemaEntry (const std::string &schemaName)
	Add a schema.
virtual const makArchives::DtSchemaEntry *	findSchemaEntry (const std::string &schemaName) const
	Add a schema.
virtual void	merge (const makArchives::DtSchema &schema)
	Merges the schema supplied into the managed schema.
virtual void	replace (const makArchives::DtSchema &schema)
	Replaces the managed schema with the schema supplied.
virtual void	exportSchemas (const std::set< std::string > &schemaNames, const std::string &filename) const
	Export the named schemas to a file.
virtual bool	renameSchemaEntry (const std::string &oldName, const std::string &newName)
	Renames the schema found in the schema to the new name and sends out signal_schemaRenamed signal.
const makArchives::DtSchema &	schema () const
	Returns the managed schema.
virtual std::string	schemaName () const
	Returns the schema name.
virtual bool	renameSchemaParameter (const std::string &schema, const std::string &oldName, const std::string &newName)
	Renames the parameter in the specified schema.
virtual void	addPossibleSchemaValue (int schema)
	Adds a value that can possible be used as a schema parameter.
virtual PossibleSchemaValues	possibleSchemaValues () const
	Returns possible schema parameter values.
virtual void	removePossibleSchemaValue (int schema)
	Removes a value that can possible be used as a schema parameter.
virtual void	loadSchemas ()
	Load all schemas from the schema path.
virtual bool	loadSchema (const std::string &filepath)
	Load the specified schema and overwrite the current schema with it.
virtual void	saveSchema ()
	Save out the current schema to its default file.
virtual void	saveSchemaAs (const std::string &filepath)
	Save the schema to a file.
virtual bool	importSchema (const std::string &filepath, bool mergeSchema)
	Import the specified schema file; overwrites the current schema or merges into it depending on the value of mergeSchema.
virtual DtSchemaSettingsBackup &	settingsBackup ()
	Get the backup object.
virtual void	backup ()
	Back up the schema settings.

Protected Member Functions
	DtSchemaManager (DtDe &)
	CTOR.
virtual void	saveSchema (const makArchives::DtSchema &schema, const std::string &file) const
	Save the specified schema to a file.

Protected Attributes
DtDe &	myDe
	Reference to the display engine.
DtSchemaManagerSignaler &	mySignaler
	Signaler to signal other classes when schemas change.
makArchives::DtSchema	myModelDefinitionSchema
	Model definition schema.
DtSchemaSettingsBackup	myModelDefinitionSchemaBackup
	Backup for model definition schema.
PossibleSchemaValues	myPossibleSchemaValues
	List of possible value types that can go in a schema.

Friends
class	DtSchemaManagerCreator

Detailed Description

The schema manager is responsible to managing all of the schemas in the system.

It will save and load definitions to/from files.

Member Typedef Documentation

typedef std::set<int> makVrv::DtSchemaManager::PossibleSchemaValues

Member Enumeration Documentation

enum makVrv::DtSchemaManager::SchemaTypes

Enumerator:

ModelDefinitionSchema
VisualDefinitionSchema

Constructor & Destructor Documentation

virtual makVrv::DtSchemaManager::~DtSchemaManager ( )

virtual

DTOR.

makVrv::DtSchemaManager::DtSchemaManager ( DtDe & )

protected

CTOR.

Member Function Documentation

virtual void makVrv::DtSchemaManager::addSchemaEntry ( const makArchives::DtSchemaEntry & schema )

virtual

Add a new model definition schema.

virtual bool makVrv::DtSchemaManager::removeSchemaEntry ( const std::string & )

virtual

Removes the schema from the specified schema and sends out a schemaRemoved signal.

virtual makArchives::DtSchemaEntry* makVrv::DtSchemaManager::findSchemaEntry ( const std::string & schemaName )

virtual

Add a schema.

If schemaType is -1, searches all schemas and returns the first occurance

virtual const makArchives::DtSchemaEntry* makVrv::DtSchemaManager::findSchemaEntry ( const std::string & schemaName ) const

virtual

Add a schema.

If schemaType is -1, searches all schemas and returns the first occurance

virtual void makVrv::DtSchemaManager::merge ( const makArchives::DtSchema & schema )

virtual

Merges the schema supplied into the managed schema.

virtual void makVrv::DtSchemaManager::replace ( const makArchives::DtSchema & schema )

virtual

Replaces the managed schema with the schema supplied.

virtual void makVrv::DtSchemaManager::exportSchemas	(	const std::set< std::string > &	schemaNames,
		const std::string &	filename
	)		const

virtual

Export the named schemas to a file.

virtual bool makVrv::DtSchemaManager::renameSchemaEntry	(	const std::string &	oldName,
		const std::string &	newName
	)

virtual

Renames the schema found in the schema to the new name and sends out signal_schemaRenamed signal.

Return values

true	if schema is renamed

const makArchives::DtSchema& makVrv::DtSchemaManager::schema ( ) const

Returns the managed schema.

virtual std::string makVrv::DtSchemaManager::schemaName ( ) const

virtual

Returns the schema name.

virtual bool makVrv::DtSchemaManager::renameSchemaParameter	(	const std::string &	schema,
		const std::string &	oldName,
		const std::string &	newName
	)

virtual

Renames the parameter in the specified schema.

Sends out a signal on rename.

Return values

true	if successfully renamed.

virtual void makVrv::DtSchemaManager::addPossibleSchemaValue ( int schema )

virtual

Adds a value that can possible be used as a schema parameter.

virtual PossibleSchemaValues makVrv::DtSchemaManager::possibleSchemaValues ( ) const

virtual

Returns possible schema parameter values.

virtual void makVrv::DtSchemaManager::removePossibleSchemaValue ( int schema )

virtual

Removes a value that can possible be used as a schema parameter.

virtual void makVrv::DtSchemaManager::loadSchemas ( )

virtual

Load all schemas from the schema path.

virtual bool makVrv::DtSchemaManager::loadSchema ( const std::string & filepath )

virtual

Load the specified schema and overwrite the current schema with it.

virtual void makVrv::DtSchemaManager::saveSchema ( )

virtual

Save out the current schema to its default file.

virtual void makVrv::DtSchemaManager::saveSchemaAs ( const std::string & filepath )

virtual

Save the schema to a file.

virtual bool makVrv::DtSchemaManager::importSchema	(	const std::string &	filepath,
		bool	mergeSchema
	)

virtual

Import the specified schema file; overwrites the current schema or merges into it depending on the value of mergeSchema.

Return values

Returns false if the file could not be loaded

virtual DtSchemaSettingsBackup& makVrv::DtSchemaManager::settingsBackup ( )

virtual

Get the backup object.

virtual void makVrv::DtSchemaManager::backup ( )

virtual

Back up the schema settings.

virtual void makVrv::DtSchemaManager::saveSchema	(	const makArchives::DtSchema &	schema,
		const std::string &	file
	)		const

protectedvirtual

Save the specified schema to a file.

Friends And Related Function Documentation

friend class DtSchemaManagerCreator

friend

Member Data Documentation

DtDe& makVrv::DtSchemaManager::myDe

protected

Reference to the display engine.

DtSchemaManagerSignaler& makVrv::DtSchemaManager::mySignaler

protected

Signaler to signal other classes when schemas change.

makArchives::DtSchema makVrv::DtSchemaManager::myModelDefinitionSchema

protected

Model definition schema.

DtSchemaSettingsBackup makVrv::DtSchemaManager::myModelDefinitionSchemaBackup

protected

Backup for model definition schema.

PossibleSchemaValues makVrv::DtSchemaManager::myPossibleSchemaValues

protected

List of possible value types that can go in a schema.

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

include/vrvCore/DtSchemaManager.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation