DtCsvScenarioMergeProject Class Reference

stl More...

Inheritance diagram for DtCsvScenarioMergeProject:

Public Member Functions
	DtCsvScenarioMergeProject ()
	default constructor
virtual	~DtCsvScenarioMergeProject ()
	destructor
	DtCsvScenarioMergeProject (const DtCsvScenarioMergeProject &orig)
	copy constructor
DtCsvScenarioMergeProject &	operator= (const DtCsvScenarioMergeProject &orig)
	assignment operator
virtual DtScenarioMergeProject *	clone () const
	clone() duplicate this object in a type-specific way, and perform a deep-copy of all data members.
virtual void	addScenarioPath (const DtFilename &filePath)
	addScenarioPath() Given the specified filePath, add/replace entry in myScenarioFilePaths data member.
virtual bool	getScenarioPath (unsigned index, DtFilename &filePath) const
	getScenarioPath() Given the specified index, attempt to retrieve the filepath from myScenarioFilePaths.
virtual void	clear ()
	clear(); Erase all stored data values, and revert to an initial state.
virtual void	getIgnoreListPath (DtFilename &filePath) const
	getIgnoreListPath() setIgnoreListPath() Accessor and mutator for myIgnoreListFilePath
virtual void	setIgnoreListPath (const DtFilename &filePath)
virtual void	getProjectFilePath (DtFilename &filePath) const
	getProjectFilePath() setProjectFilePath() Accessor and mutator for myInProjectFilePath, which is a file that contains all the values to be used in this object's data members.
virtual void	setProjectFilePath (const DtFilename &filePath)
virtual bool	interpretFields (std::deque< std::string > &line)
	interpretFields() returns true if it finds a field it understands the supplied CSV fields
virtual unsigned	numScenarios () const
	numScenarios() returns myScenarioFilePaths.size()
virtual bool	readAndParseLine (FILE *fp, std::deque< std::string > &que) const
	readAndParseLine() Read a line from a valid, open file pointer.
virtual bool	readProjectFile ()
	readProjectFile() Opens file specified by myInProjectFilePath, parses CSV data therein, returns true if success, false if failure.
virtual bool	readProjectFile (const DtFilename &filepath)
	readProjectFile() Assigns filepath to myInProjectFilePath, opens file, parses CSV data therein, returns true if success, false if failure.
virtual bool	removeScenarioPath (const DtFilename &filePath)
	removeScenarioPath() Search for filePath in myScenarioFilePaths, remove if found.
virtual void	getMergeFile (DtFilename &filePath) const
	getMergeFile() setMergeFile() Accessor and mutator for myOutScenario
virtual void	setMergeFile (const DtFilename &folderPath)
	setMergeFile Specify a file to merge scenarios to
virtual bool	writeProjectFile ()
	writeProjectFile() Generate an output scenario name based on myOutScenarioPath, open that file, write member data in CSV format.
virtual bool	writeProjectFile (const DtFilename &folderPath)
Public Member Functions inherited from DtScenarioMergeProject
	DtScenarioMergeProject ()
	default constructor
virtual	~DtScenarioMergeProject ()
	destructor
	DtScenarioMergeProject (const DtScenarioMergeProject &orig)
	copy constructor
DtScenarioMergeProject &	operator= (const DtScenarioMergeProject &orig)
	assignment operator

Protected Attributes
DtFilename	myIgnoreListFilePath
DtFilename	myInProjectFilePath
DtFilename	myOutScenario
std::deque< DtFilename >	myScenarioFilePaths

Detailed Description

stl

VR-Link Util class DtCsvScenarioMergeProject

DtCsvScenarioMergeProject implements the DtScenarioMergeProject interface. It is used by DtScenarioMergeDirector to describe a collection of files and parameters that will be used to combine two standalone VR-Forces scenarios.

Constructor & Destructor Documentation

DtCsvScenarioMergeProject::DtCsvScenarioMergeProject

(

)

default constructor

virtual DtCsvScenarioMergeProject::~DtCsvScenarioMergeProject ( )

virtual

destructor

DtCsvScenarioMergeProject::DtCsvScenarioMergeProject

(

const DtCsvScenarioMergeProject &

orig

)

copy constructor

Member Function Documentation

DtCsvScenarioMergeProject& DtCsvScenarioMergeProject::operator=

(

const DtCsvScenarioMergeProject &

orig

)

assignment operator

virtual DtScenarioMergeProject* DtCsvScenarioMergeProject::clone ( ) const

virtual

clone() duplicate this object in a type-specific way, and perform a deep-copy of all data members.

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::addScenarioPath ( const DtFilename &  filePath )

virtual

addScenarioPath() Given the specified filePath, add/replace entry in myScenarioFilePaths data member.

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::getScenarioPath ( unsigned  index, DtFilename &  filePath  ) const

virtual

getScenarioPath() Given the specified index, attempt to retrieve the filepath from myScenarioFilePaths.

Returns true if success, false if failure.

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::clear ( )

virtual

clear(); Erase all stored data values, and revert to an initial state.

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::getIgnoreListPath ( DtFilename &  filePath ) const

virtual

getIgnoreListPath() setIgnoreListPath() Accessor and mutator for myIgnoreListFilePath

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::setIgnoreListPath ( const DtFilename &  filePath )

virtual

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::getProjectFilePath ( DtFilename &  filePath ) const

virtual

getProjectFilePath() setProjectFilePath() Accessor and mutator for myInProjectFilePath, which is a file that contains all the values to be used in this object's data members.

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::setProjectFilePath ( const DtFilename &  filePath )

virtual

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::interpretFields ( std::deque< std::string > &  line )

virtual

interpretFields() returns true if it finds a field it understands the supplied CSV fields

virtual unsigned DtCsvScenarioMergeProject::numScenarios ( ) const

virtual

numScenarios() returns myScenarioFilePaths.size()

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::readAndParseLine ( FILE *  fp, std::deque< std::string > &  que  ) const

virtual

readAndParseLine() Read a line from a valid, open file pointer.

File is assumed to contain comma-delimited data. Return data in que parameter Return bool to continue processing.

virtual bool DtCsvScenarioMergeProject::readProjectFile ( )

virtual

readProjectFile() Opens file specified by myInProjectFilePath, parses CSV data therein, returns true if success, false if failure.

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::readProjectFile ( const DtFilename &  filepath )

virtual

readProjectFile() Assigns filepath to myInProjectFilePath, opens file, parses CSV data therein, returns true if success, false if failure.

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::removeScenarioPath ( const DtFilename &  filePath )

virtual

removeScenarioPath() Search for filePath in myScenarioFilePaths, remove if found.

Returns true if found and removed.

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::getMergeFile ( DtFilename &  filePath ) const

virtual

getMergeFile() setMergeFile() Accessor and mutator for myOutScenario

Implements DtScenarioMergeProject.

virtual void DtCsvScenarioMergeProject::setMergeFile ( const DtFilename &  folderPath )

virtual

setMergeFile Specify a file to merge scenarios to

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::writeProjectFile ( )

virtual

writeProjectFile() Generate an output scenario name based on myOutScenarioPath, open that file, write member data in CSV format.

Implements DtScenarioMergeProject.

virtual bool DtCsvScenarioMergeProject::writeProjectFile ( const DtFilename &  folderPath )

virtual

Implements DtScenarioMergeProject.

Member Data Documentation

DtFilename DtCsvScenarioMergeProject::myIgnoreListFilePath

protected

DtFilename DtCsvScenarioMergeProject::myInProjectFilePath

protected

DtFilename DtCsvScenarioMergeProject::myOutScenario

protected

std::deque<DtFilename> DtCsvScenarioMergeProject::myScenarioFilePaths

protected

---

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

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