class DtVrfPluginRecordManager:

This class is a collection of plugin records that are read and saved from the supplied directory. Variables configuration and platform are filled in automatically. Application and transport must be set in order to return correct plugin information

Inheritance diagram for DtVrfPluginRecordManager:

[legend]

Public Types
typedef std::vector < DtVrfPluginRecord >	PluginRecords

Public Member Functions
	DtVrfPluginRecordManager ()

virtual	~DtVrfPluginRecordManager ()

virtual void	clear ()

virtual void	readPluginsFrom (const std::string &directory)

void	setApplication (const std::string &application)

virtual const std::string &	application () const

void	setPlatform (const std::string &platform)

virtual const std::string &	platform () const

virtual void	addTransport (const std::string &)

virtual void	removeTransport (const std::string &)

virtual const std::vector < std::string > &	transports () const

void	setConfiguration (const std::string &)

virtual const std::string &	configuration () const

virtual std::vector< std::string >	pluginsToLoad () const

virtual const PluginRecords &	plugins () const

virtual PluginRecords &	plugins ()

virtual void	addPluginRecord (const DtVrfPluginRecord &)

virtual bool	removePluginRecord (const std::string &)

virtual bool	removePlugin (const std::string &fileName, const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport)

virtual bool	addPlugin (const std::string &fileName, const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport)

virtual bool	renamePluginRecord (const std::string &curFileName, const std::string &newName)

virtual DtVrfPluginRecord	pluginRecord (const std::string &fileName) const

virtual void	setPlugin (const std::string &fileName, const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport, const std::string &plugin)

virtual void	setLoadPlugin (const std::string &filename, bool b)

bool	autoSave () const

void	setAutoSave (bool)

Protected Attributes
PluginRecords	myPluginRecords

std::string	myPlatform

std::string	myConfiguration

std::string	myApplication

std::vector< std::string >	myTransports

bool	myAutoSave

Private Member Functions
	DtVrfPluginRecordManager (const DtVrfPluginRecordManager &)

DtVrfPluginRecordManager &	operator= (const DtVrfPluginRecordManager &)

Member Typedef Documentation

typedef std::vector<DtVrfPluginRecord> DtVrfPluginRecordManager::PluginRecords

Constructor & Destructor Documentation

DtVrfPluginRecordManager::DtVrfPluginRecordManager ( )

CTOR.

virtual DtVrfPluginRecordManager::~DtVrfPluginRecordManager ( )

virtual

DtVrfPluginRecordManager::DtVrfPluginRecordManager ( const DtVrfPluginRecordManager & )

private

Member Function Documentation

DtVrfPluginRecordManager& DtVrfPluginRecordManager::operator= ( const DtVrfPluginRecordManager & )

private

virtual void DtVrfPluginRecordManager::clear ( )

virtual

Clears records of plugins to load.

virtual void DtVrfPluginRecordManager::readPluginsFrom ( const std::string & directory )

virtual

Reads the plugins to load from the specified directory.

void DtVrfPluginRecordManager::setApplication ( const std::string & application )

Map by application (vrfSim, vrfGui, etc.)

virtual const std::string& DtVrfPluginRecordManager::application ( ) const

virtual

void DtVrfPluginRecordManager::setPlatform ( const std::string & platform )

Map by platform (Windows, Irix, Linux, etc.)

virtual const std::string& DtVrfPluginRecordManager::platform ( ) const

virtual

virtual void DtVrfPluginRecordManager::addTransport ( const std::string & )

virtual

Map by protocol (DIS, HLA13, HLA1516 or Independent)

virtual void DtVrfPluginRecordManager::removeTransport ( const std::string & )

virtual

virtual const std::vector<std::string>& DtVrfPluginRecordManager::transports ( ) const

virtual

void DtVrfPluginRecordManager::setConfiguration ( const std::string & )

Map by build configuration (Release, Debug or Unknown)

virtual const std::string& DtVrfPluginRecordManager::configuration ( ) const

virtual

virtual std::vector<std::string> DtVrfPluginRecordManager::pluginsToLoad ( ) const

virtual

Returns a list of all plugins to load given.

virtual const PluginRecords& DtVrfPluginRecordManager::plugins ( ) const

virtual

virtual PluginRecords& DtVrfPluginRecordManager::plugins ( )

virtual

virtual void DtVrfPluginRecordManager::addPluginRecord ( const DtVrfPluginRecord & )

virtual

Adds the specified plugin record.

Reimplemented in makVrf::DtVrfGuiPluginManager.

virtual bool DtVrfPluginRecordManager::removePluginRecord ( const std::string & )

virtual

The record to remove must be the filename that matches a plugin record.

Reimplemented in makVrf::DtVrfGuiPluginManager.

virtual bool DtVrfPluginRecordManager::removePlugin	(	const std::string &	fileName,
		const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport
	)

virtual

Removes the plugin line from the specified plugin. Will return true if the plugin line exists and is removed.

Reimplemented in makVrf::DtVrfGuiPluginManager.

virtual bool DtVrfPluginRecordManager::addPlugin	(	const std::string &	fileName,
		const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport
	)

virtual

Adds the plugin line to the specified plugin. Will return true if the plugin line is added. If the record already exists, will return false.

Reimplemented in makVrf::DtVrfGuiPluginManager.

virtual bool DtVrfPluginRecordManager::renamePluginRecord	(	const std::string &	curFileName,
		const std::string &	newName
	)

virtual

Renames plugin to new file name. Will save new record if auto save is true. Does not delete original.

Reimplemented in makVrf::DtVrfGuiPluginManager.

virtual DtVrfPluginRecord DtVrfPluginRecordManager::pluginRecord ( const std::string & fileName ) const

virtual

Returns a record with the given filename. If no record exists, blank record is returned.

virtual void DtVrfPluginRecordManager::setPlugin	(	const std::string &	fileName,
		const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport,
		const std::string &	plugin
	)

virtual

Sets the plugin to load.

virtual void DtVrfPluginRecordManager::setLoadPlugin	(	const std::string &	filename,
		bool	b
	)

virtual

Sets whether or not to load the particular plugin. If record autoSave is true, will automatically save.

Reimplemented in makVrf::DtVrfGuiPluginManager.

bool DtVrfPluginRecordManager::autoSave ( ) const

void DtVrfPluginRecordManager::setAutoSave ( bool )

Member Data Documentation

PluginRecords DtVrfPluginRecordManager::myPluginRecords

protected

std::string DtVrfPluginRecordManager::myPlatform

protected

std::string DtVrfPluginRecordManager::myConfiguration

protected

std::string DtVrfPluginRecordManager::myApplication

protected

std::vector<std::string> DtVrfPluginRecordManager::myTransports

protected

bool DtVrfPluginRecordManager::myAutoSave

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfutil/vrfPluginRecordManager.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation