 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
class DtScenarioMergeProject More...
Public Member Functions | |
| DtScenarioMergeProject () | |
| default constructor | |
| virtual | ~DtScenarioMergeProject () |
| destructor | |
| DtScenarioMergeProject (const DtScenarioMergeProject &orig) | |
| copy constructor | |
| DtScenarioMergeProject & | operator= (const DtScenarioMergeProject &orig) |
| assignment operator | |
| virtual DtScenarioMergeProject * | clone () const =0 |
| clone() duplicate this object in a type-specific way, and perform a deep-copy of all data members. | |
| virtual void | addScenarioPath (const DtFilename &filePath)=0 |
| addScenarioPath() Given the specified filePath, add/replace entry in some storage data member, to be defined by implementation. | |
| virtual bool | getScenarioPath (unsigned index, DtFilename &filePath) const =0 |
| getScenarioPath() Given the specified index, attempt to retrieve the filepath from some storage data member, to be defined by implementation. | |
| virtual void | clear ()=0 |
| clear(); Erase all stored data values, and revert to an initial state. | |
| virtual void | getIgnoreListPath (DtFilename &filePath) const =0 |
| getIgnoreListPath() setIgnoreListPath() Accessor and mutator for a data member to be defined by the implementation. | |
| virtual void | setIgnoreListPath (const DtFilename &filePath)=0 |
| virtual void | getProjectFilePath (DtFilename &filePath) const =0 |
| getProjectFilePath() setProjectFilePath() Accessor and mutator for a data member to be defined by the implementation. | |
| virtual void | setProjectFilePath (const DtFilename &filePath)=0 |
| virtual unsigned | numScenarios () const =0 |
| numScenarios() Represents the number of scenarios that will be merged together. | |
| virtual bool | readProjectFile ()=0 |
| readProjectFile() Opens a project file whose name was defined previously, then reads the data into memory. | |
| virtual bool | readProjectFile (const DtFilename &filepath)=0 |
| readProjectFile() Opens a the specified project file, then reads the data into memory. | |
| virtual bool | removeScenarioPath (const DtFilename &filePath)=0 |
| removeScenarioPath() Search for the specified filepath in a collection of scenario filenames, and remove the filepath from the collection. | |
| virtual void | getMergeFile (DtFilename &filePath) const =0 |
| getMergeFile() Retrieve the file that the scenarios are being merged to. | |
| virtual void | setMergeFile (const DtFilename &folderPath)=0 |
| setMergeFile Specify a file to merge scenarios to | |
| virtual bool | writeProjectFile ()=0 |
| writeProjectFile() Cause the scenario merge project to be written to storage. | |
| virtual bool | writeProjectFile (const DtFilename &folderPath)=0 |
class DtScenarioMergeProject
DtScenarioMergeProject is an interface class used to describe a collection of files and parameters that will be used to combine two standalone VR-Forces scenarios.
| DtScenarioMergeProject::DtScenarioMergeProject | ( | ) | [inline] |
default constructor
| virtual DtScenarioMergeProject::~DtScenarioMergeProject | ( | ) | [inline, virtual] |
destructor
| DtScenarioMergeProject::DtScenarioMergeProject | ( | const DtScenarioMergeProject & | orig | ) | [inline] |
copy constructor
| DtScenarioMergeProject& DtScenarioMergeProject::operator= | ( | const DtScenarioMergeProject & | orig | ) | [inline] |
assignment operator
| virtual DtScenarioMergeProject* DtScenarioMergeProject::clone | ( | ) | const [pure virtual] |
clone() duplicate this object in a type-specific way, and perform a deep-copy of all data members.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::addScenarioPath | ( | const DtFilename & | filePath | ) | [pure virtual] |
addScenarioPath() Given the specified filePath, add/replace entry in some storage data member, to be defined by implementation.
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::getScenarioPath | ( | unsigned | index, |
| DtFilename & | filePath | ||
| ) | const [pure virtual] |
getScenarioPath() Given the specified index, attempt to retrieve the filepath from some storage data member, to be defined by implementation.
Returns true if success, false if failure.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::clear | ( | ) | [pure virtual] |
clear(); Erase all stored data values, and revert to an initial state.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::getIgnoreListPath | ( | DtFilename & | filePath | ) | const [pure virtual] |
getIgnoreListPath() setIgnoreListPath() Accessor and mutator for a data member to be defined by the implementation.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::setIgnoreListPath | ( | const DtFilename & | filePath | ) | [pure virtual] |
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::getProjectFilePath | ( | DtFilename & | filePath | ) | const [pure virtual] |
getProjectFilePath() setProjectFilePath() Accessor and mutator for a data member to be defined by the implementation.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::setProjectFilePath | ( | const DtFilename & | filePath | ) | [pure virtual] |
Implemented in DtCsvScenarioMergeProject.
| virtual unsigned DtScenarioMergeProject::numScenarios | ( | ) | const [pure virtual] |
numScenarios() Represents the number of scenarios that will be merged together.
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::readProjectFile | ( | ) | [pure virtual] |
readProjectFile() Opens a project file whose name was defined previously, then reads the data into memory.
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::readProjectFile | ( | const DtFilename & | filepath | ) | [pure virtual] |
readProjectFile() Opens a the specified project file, then reads the data into memory.
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::removeScenarioPath | ( | const DtFilename & | filePath | ) | [pure virtual] |
removeScenarioPath() Search for the specified filepath in a collection of scenario filenames, and remove the filepath from the collection.
Returns true if the filepath was found.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::getMergeFile | ( | DtFilename & | filePath | ) | const [pure virtual] |
getMergeFile() Retrieve the file that the scenarios are being merged to.
Implemented in DtCsvScenarioMergeProject.
| virtual void DtScenarioMergeProject::setMergeFile | ( | const DtFilename & | folderPath | ) | [pure virtual] |
setMergeFile Specify a file to merge scenarios to
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::writeProjectFile | ( | ) | [pure virtual] |
writeProjectFile() Cause the scenario merge project to be written to storage.
Does not merge scenarios, rather it simply saves a list of scenarios to be merged, and parameters for a merge operation.
Implemented in DtCsvScenarioMergeProject.
| virtual bool DtScenarioMergeProject::writeProjectFile | ( | const DtFilename & | folderPath | ) | [pure virtual] |
Implemented in DtCsvScenarioMergeProject.