class DtVrfPluginRecord:

This class will define a plugin that can be loaded by either the front or back end

Public Types
typedef std::map< std::string, std::string >	PluginData

typedef std::map< std::string, PluginData >	TransportConfigurationMap

typedef std::map< std::string, TransportConfigurationMap >	BuildConfigurationMap

typedef std::map< std::string, BuildConfigurationMap >	PlatformMap

typedef std::map< std::string, PlatformMap >	PluginMap

Public Member Functions
	DtVrfPluginRecord ()

	DtVrfPluginRecord (const DtVrfPluginRecord &)

virtual	~DtVrfPluginRecord ()

virtual bool	load (const std::string &file)

virtual bool	save (const std::string &file)

virtual bool	save ()

virtual const std::string &	file () const

DtVrfPluginRecord &	operator= (const DtVrfPluginRecord &)

virtual std::string	name () const

virtual bool	rename (const std::string &newName)

void	setAutoSave (bool)

bool	autoSave () const

void	setApplication (const std::string &application)

virtual const std::string &	application () const

void	setPlatform (const std::string &platform)

virtual const std::string &	platform () const

void	setTransport (const std::string &transport)

virtual const std::string &	transport () const

void	setConfiguration (const std::string &)

virtual const std::string &	configuration () const

virtual std::string	value (const std::string &key) const

virtual std::string	value (const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport, const std::string &key) const

virtual std::string	plugin () const

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

virtual bool	loadPlugin () const

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

virtual void	setPlugin (const std::string &)

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

virtual PluginData	pluginData () const

virtual PluginData	pluginData (const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport) const

virtual void	setPluginData (const std::string &key, const std::string &value)

virtual void	setPluginData (const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport, const std::string &key, const std::string &value)

virtual bool	removePlugin ()

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

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

virtual bool	removePluginData (const std::string &key)

virtual bool	removePluginData (const std::string &application, const std::string &platform, const std::string &configuration, const std::string &transport, const std::string &key)

const PluginMap &	pluginStructure () const

void	setLoad (bool)

virtual bool	load () const

Protected Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Protected Attributes
PluginMap	myPluginData

std::string	myPlatform

std::string	myConfiguration

std::string	myTransport

std::string	myApplication

std::string	myFile

bool	myLoad

bool	myAutoSave

Friends
class	boost::serialization::access

Member Typedef Documentation

typedef std::map<std::string, std::string> DtVrfPluginRecord::PluginData

Plugin data map (keyword/value pairs)

typedef std::map<std::string, PluginData> DtVrfPluginRecord::TransportConfigurationMap

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

typedef std::map<std::string, TransportConfigurationMap> DtVrfPluginRecord::BuildConfigurationMap

Map by build configuration (release, debug or any)

typedef std::map<std::string, BuildConfigurationMap> DtVrfPluginRecord::PlatformMap

Map by platform (windows, irix, linux, etc.)

typedef std::map<std::string, PlatformMap> DtVrfPluginRecord::PluginMap

Map by application (vrfSim, vrfGui, etc.)

Constructor & Destructor Documentation

DtVrfPluginRecord::DtVrfPluginRecord ( )

default constructor

DtVrfPluginRecord::DtVrfPluginRecord ( const DtVrfPluginRecord & )

virtual DtVrfPluginRecord::~DtVrfPluginRecord ( )

virtual

destructor

Member Function Documentation

virtual bool DtVrfPluginRecord::load ( const std::string & file )

virtual

Loads the record from the specified file.

virtual bool DtVrfPluginRecord::save ( const std::string & file )

virtual

Saves the record to the specified file.

virtual bool DtVrfPluginRecord::save ( )

virtual

virtual const std::string& DtVrfPluginRecord::file ( ) const

virtual

DtVrfPluginRecord& DtVrfPluginRecord::operator= ( const DtVrfPluginRecord & )

virtual std::string DtVrfPluginRecord::name ( ) const

virtual

The name is the file name loaded stripped of path and extension.

virtual bool DtVrfPluginRecord::rename ( const std::string & newName )

virtual

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

void DtVrfPluginRecord::setAutoSave ( bool )

bool DtVrfPluginRecord::autoSave ( ) const

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

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

virtual

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

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

virtual

void DtVrfPluginRecord::setTransport ( const std::string & transport )

virtual const std::string& DtVrfPluginRecord::transport ( ) const

virtual

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

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

virtual

virtual std::string DtVrfPluginRecord::value ( const std::string & key ) const

virtual

virtual std::string DtVrfPluginRecord::value	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport,
		const std::string &	key
	)		const

virtual

virtual std::string DtVrfPluginRecord::plugin ( ) const

virtual

virtual std::string DtVrfPluginRecord::plugin	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport
	)		const

virtual

virtual bool DtVrfPluginRecord::loadPlugin ( ) const

virtual

virtual bool DtVrfPluginRecord::loadPlugin	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport
	)		const

virtual

virtual void DtVrfPluginRecord::setPlugin ( const std::string & )

virtual

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

virtual

virtual PluginData DtVrfPluginRecord::pluginData ( ) const

virtual

Returns plugin data given the current settings for application, platform, etc. To get entire tree, call pluginStructure.

virtual PluginData DtVrfPluginRecord::pluginData	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport
	)		const

virtual

virtual void DtVrfPluginRecord::setPluginData	(	const std::string &	key,
		const std::string &	value
	)

virtual

virtual void DtVrfPluginRecord::setPluginData	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport,
		const std::string &	key,
		const std::string &	value
	)

virtual

virtual bool DtVrfPluginRecord::removePlugin ( )

virtual

Removes the plugin line from the specified plugin. Will return true if the plugin line exists and is removed. Will save if auto-save is turned on. Returns true if removed.

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

virtual

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

virtual

Adds the plugin line from to specified plugin. Will return true if the plugin line does not exists and is added. Will save if auto-save is turned on.

virtual bool DtVrfPluginRecord::removePluginData ( const std::string & key )

virtual

Removes the plugin line from the specified plugin. Will return true if the plugin line exists and is removed. Will save if auto-save is turned on. Returns true if removed.

virtual bool DtVrfPluginRecord::removePluginData	(	const std::string &	application,
		const std::string &	platform,
		const std::string &	configuration,
		const std::string &	transport,
		const std::string &	key
	)

virtual

const PluginMap& DtVrfPluginRecord::pluginStructure ( ) const

void DtVrfPluginRecord::setLoad ( bool )

Whether or not to load any plugin contained in this file.

virtual bool DtVrfPluginRecord::load ( ) const

virtual

template<class Archive >

void DtVrfPluginRecord::serialize	(	Archive &	ar,
		const unsigned int	version
	)

inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<. Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Member Data Documentation

PluginMap DtVrfPluginRecord::myPluginData

protected

std::string DtVrfPluginRecord::myPlatform

protected

std::string DtVrfPluginRecord::myConfiguration

protected

std::string DtVrfPluginRecord::myTransport

protected

std::string DtVrfPluginRecord::myApplication

protected

std::string DtVrfPluginRecord::myFile

protected

bool DtVrfPluginRecord::myLoad

protected

bool DtVrfPluginRecord::myAutoSave

protected

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation