DtScenarioDescriptionImporterExporter Class Reference

This class is the interface for a scenario description importer/exporter. More...

Inheritance diagram for DtScenarioDescriptionImporterExporter:

Public Member Functions
	DtScenarioDescriptionImporterExporter ()
	CTOR Derived classes will need to create a parser.
virtual	~DtScenarioDescriptionImporterExporter ()
	DTOR.
virtual bool	loadScenarioDescription (const DtFilename &file, const std::map< std::string, std::string > &importData)=0
const DtScenario &	scenario () const
const std::string &	error () const
virtual DtScenarioDescriptionImporterExporter *	clone ()=0
	Clone to create a new copy of the object. Will be used as a "clean" version for import.
virtual bool	importIntoSimulation (DtSimManager *)=0
	Imports into the simulation.
virtual bool	importFromSimulation (DtSimManager *, const std::map< std::string, std::string > &exportData, const DtMsdlHierarchyPropertyMappings &)=0
	Imports from the simulation into internal structures.
virtual bool	saveScenarioDescription (const DtFilename &file, const DtScenario &) const =0
	Saves the scenario description information to the specified file.
virtual void	setDesiredForce (int force)
virtual DtObjectParser *	parser ()=0
	Returns parser, if doesn't exist yet will create it.
virtual std::string	supportedExtensions ()=0
	Returns a space delimeted list of the extensions supported (i.e. "xml" or "csv txt")
virtual bool	canImportFile (const DtFilename &)=0
	Returns true if the supplied file can be loaded by this importer.
virtual bool	complete () const
	Return true if import is complete. Default is true.

Protected Attributes
DtScenario	myScenario
std::string	myError
DtObjectParser *	myParser
DtForceType	myDesiredForce

Detailed Description

This class is the interface for a scenario description importer/exporter.

Subclasses will implement the specified virtual methods to load/export the scenario description file.

Constructor & Destructor Documentation

DtScenarioDescriptionImporterExporter::DtScenarioDescriptionImporterExporter

(

)

CTOR Derived classes will need to create a parser.

virtual DtScenarioDescriptionImporterExporter::~DtScenarioDescriptionImporterExporter ( )

virtual

DTOR.

Member Function Documentation

virtual bool DtScenarioDescriptionImporterExporter::loadScenarioDescription ( const DtFilename &  file, const std::map< std::string, std::string > &  importData  )

pure virtual

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, and DtCsvScenarioDescriptionImporterExporter.

const DtScenario& DtScenarioDescriptionImporterExporter::scenario

(

)

const

const std::string& DtScenarioDescriptionImporterExporter::error

(

)

const

virtual DtScenarioDescriptionImporterExporter* DtScenarioDescriptionImporterExporter::clone ( )

pure virtual

Clone to create a new copy of the object. Will be used as a "clean" version for import.

Implemented in DtMsdlScenarioDescriptionImporterExporter, makVrf::DtVrfMsdlOrbatImporterExporter, DtVrfCSVScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, DtCsvScenarioDescriptionImporterExporter, DtVrfCsvScenarioDescriptionImporterExporter, and DtVrfMsdlScenarioDescriptionImporterExporter.

virtual bool DtScenarioDescriptionImporterExporter::importIntoSimulation ( DtSimManager *  )

pure virtual

Imports into the simulation.

DtSimManager is not defined at this level, so subclasses at vrfobjcore level must implement

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtVrfCSVScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, DtCsvScenarioDescriptionImporterExporter, DtVrfCsvScenarioDescriptionImporterExporter, and DtVrfMsdlScenarioDescriptionImporterExporter.

virtual bool DtScenarioDescriptionImporterExporter::importFromSimulation ( DtSimManager *  , const std::map< std::string, std::string > &  exportData, const DtMsdlHierarchyPropertyMappings &    )

pure virtual

Imports from the simulation into internal structures.

DtSimManager is not defined at this level, so subclasses at vrfobjcore level must implement

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtVrfCSVScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, DtCsvScenarioDescriptionImporterExporter, DtVrfCsvScenarioDescriptionImporterExporter, and DtVrfMsdlScenarioDescriptionImporterExporter.

virtual bool DtScenarioDescriptionImporterExporter::saveScenarioDescription ( const DtFilename &  file, const DtScenario &    ) const

pure virtual

Saves the scenario description information to the specified file.

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, and DtCsvScenarioDescriptionImporterExporter.

virtual void DtScenarioDescriptionImporterExporter::setDesiredForce ( int  force )

virtual

virtual DtObjectParser* DtScenarioDescriptionImporterExporter::parser ( )

pure virtual

Returns parser, if doesn't exist yet will create it.

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtCsvScenarioDescriptionImporterExporter, and DtExCSVScenarioDescriptionImporterExporter.

virtual std::string DtScenarioDescriptionImporterExporter::supportedExtensions ( )

pure virtual

Returns a space delimeted list of the extensions supported (i.e. "xml" or "csv txt")

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, and DtCsvScenarioDescriptionImporterExporter.

virtual bool DtScenarioDescriptionImporterExporter::canImportFile ( const DtFilename &  )

pure virtual

Returns true if the supplied file can be loaded by this importer.

Implemented in DtMsdlScenarioDescriptionImporterExporter, DtExCSVScenarioDescriptionImporterExporter, and DtCsvScenarioDescriptionImporterExporter.

virtual bool DtScenarioDescriptionImporterExporter::complete ( ) const

virtual

Return true if import is complete. Default is true.

Reimplemented in DtVrfMsdlScenarioDescriptionImporterExporter, DtVrfCSVScenarioDescriptionImporterExporter, and DtVrfCsvScenarioDescriptionImporterExporter.

Member Data Documentation

DtScenario DtScenarioDescriptionImporterExporter::myScenario

protected

std::string DtScenarioDescriptionImporterExporter::myError

mutableprotected

DtObjectParser* DtScenarioDescriptionImporterExporter::myParser

protected

DtForceType DtScenarioDescriptionImporterExporter::myDesiredForce

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/scenarioDescriptionImporterExporter.h