VR-Forces 4.2 Class Documentation
List of all members | Public Types | Public Member Functions | Protected Attributes
DtScenarioMergeData Class Reference

stl More...

Public Types

typedef std::deque< std::pair
< DtFilename, DtScenario > > 
ScenarioQue
typedef ScenarioQue::iterator ScenarioQueIterator
typedef ScenarioQue::const_iterator const_ScenarioQueIterator

Public Member Functions

 DtScenarioMergeData ()
 default constructor
virtual ~DtScenarioMergeData ()
 destructor
 DtScenarioMergeData (const DtScenarioMergeData &orig)
 copy constructor
DtScenarioMergeDataoperator= (const DtScenarioMergeData &orig)
 assignment operator
virtual bool addScenario (const DtFilename &fname)
 addScenario() First removes preexisting scenario identified by fname, then adds a new instance of a scenario under that name, loads that scenario from disk.
virtual
DtScenarioMergeData::const_ScenarioQueIterator 
begin () const
 begin() Returns myScenarioQue.begin()
virtual void clear ()
 clear() Erase all data.
virtual
DtObjectNameDeconflictionTable
deconflictionTable ()
 deconflictionTable() Accessor for myDeconflictionTable
virtual const
DtObjectNameDeconflictionTable
deconflictionTable () const
virtual
DtScenarioMergeData::const_ScenarioQueIterator 
end () const
 end() Returns myScenarioQue.end()
virtual
DtScenarioMergeData::ScenarioQueIterator 
findScenarioEntry (const DtFilename &fname)
 findScenarioEntry() Search myScenarioQue for a DtScenario entry keyed by fname.
virtual
DtScenarioMergeData::const_ScenarioQueIterator 
findScenarioEntry (const DtFilename &fname) const
 findScenarioEntry() Search myScenarioQue for a DtScenario entry keyed by fname.
virtual bool loadStringReplacementTable (const DtFilename fname)
 loadStringReplacementTable() Clear myStringReplacementTable, replace with data found in file identified by fname.
virtual unsigned numScenarioEntries () const
 numScenarioEntries() Returns myScenarioQue.size();
virtual void removeScenario (const DtFilename &fname)
 removeScenario() Search for scenario in myScenarioQue keyed by fname.
virtual DtStringReplacementTablestringReplacementTable ()
 stringReplacementTable() Returns myStringReplacementTable
virtual const
DtStringReplacementTable
stringReplacementTable () const
virtual const std::map
< std::string,
DtScriptedTaskMetaData > & 
scriptedTaskMetaData () const
virtual std::map< std::string,
DtScriptedTaskMetaData > & 
scriptedTaskMetaData ()

Protected Attributes

DtObjectNameDeconflictionTable myDeconflictionTable
ScenarioQue myScenarioQue
DtStringReplacementTable myStringReplacementTable
std::map< std::string,
DtScriptedTaskMetaData
myScriptedTaskMetaData

Detailed Description

stl

VR-Forces vrfcore class DtScenarioMergeData

DtScenarioMergeData holds a collection of DtScenarios, along with data that supports the merging of scenarios.

Member Typedef Documentation

typedef std::deque< std::pair<DtFilename,DtScenario> > DtScenarioMergeData::ScenarioQue
typedef ScenarioQue::iterator DtScenarioMergeData::ScenarioQueIterator
typedef ScenarioQue::const_iterator DtScenarioMergeData::const_ScenarioQueIterator

Constructor & Destructor Documentation

DtScenarioMergeData::DtScenarioMergeData ( )

default constructor

virtual DtScenarioMergeData::~DtScenarioMergeData ( )
virtual

destructor

DtScenarioMergeData::DtScenarioMergeData ( const DtScenarioMergeData orig)

copy constructor

Member Function Documentation

DtScenarioMergeData& DtScenarioMergeData::operator= ( const DtScenarioMergeData orig)

assignment operator

virtual bool DtScenarioMergeData::addScenario ( const DtFilename &  fname)
virtual

addScenario() First removes preexisting scenario identified by fname, then adds a new instance of a scenario under that name, loads that scenario from disk.

virtual DtScenarioMergeData::const_ScenarioQueIterator DtScenarioMergeData::begin ( ) const
virtual

begin() Returns myScenarioQue.begin()

virtual void DtScenarioMergeData::clear ( )
virtual

clear() Erase all data.

virtual DtObjectNameDeconflictionTable& DtScenarioMergeData::deconflictionTable ( )
virtual

deconflictionTable() Accessor for myDeconflictionTable

virtual const DtObjectNameDeconflictionTable& DtScenarioMergeData::deconflictionTable ( ) const
virtual
virtual DtScenarioMergeData::const_ScenarioQueIterator DtScenarioMergeData::end ( ) const
virtual

end() Returns myScenarioQue.end()

virtual DtScenarioMergeData::ScenarioQueIterator DtScenarioMergeData::findScenarioEntry ( const DtFilename &  fname)
virtual

findScenarioEntry() Search myScenarioQue for a DtScenario entry keyed by fname.

Returns iterator representing entry, or myScenarioQue.end().

virtual DtScenarioMergeData::const_ScenarioQueIterator DtScenarioMergeData::findScenarioEntry ( const DtFilename &  fname) const
virtual

findScenarioEntry() Search myScenarioQue for a DtScenario entry keyed by fname.

Returns iterator representing entry, or myScenarioQue.end().

virtual bool DtScenarioMergeData::loadStringReplacementTable ( const DtFilename  fname)
virtual

loadStringReplacementTable() Clear myStringReplacementTable, replace with data found in file identified by fname.

virtual unsigned DtScenarioMergeData::numScenarioEntries ( ) const
virtual

numScenarioEntries() Returns myScenarioQue.size();

virtual void DtScenarioMergeData::removeScenario ( const DtFilename &  fname)
virtual

removeScenario() Search for scenario in myScenarioQue keyed by fname.

If found, remove.

virtual DtStringReplacementTable& DtScenarioMergeData::stringReplacementTable ( )
virtual

stringReplacementTable() Returns myStringReplacementTable

virtual const DtStringReplacementTable& DtScenarioMergeData::stringReplacementTable ( ) const
virtual
virtual const std::map<std::string, DtScriptedTaskMetaData>& DtScenarioMergeData::scriptedTaskMetaData ( ) const
virtual
virtual std::map<std::string, DtScriptedTaskMetaData>& DtScenarioMergeData::scriptedTaskMetaData ( )
virtual

Member Data Documentation

DtObjectNameDeconflictionTable DtScenarioMergeData::myDeconflictionTable
protected
ScenarioQue DtScenarioMergeData::myScenarioQue
protected
DtStringReplacementTable DtScenarioMergeData::myStringReplacementTable
protected
std::map<std::string, DtScriptedTaskMetaData> DtScenarioMergeData::myScriptedTaskMetaData
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)