VR-Forces 4.0.4 Class Documentation: include/vrfutil/scnBatchRcrd.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2004 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: scnBatchRcrd.h,v $ $Revision: 1.10 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00012 #ifndef DtScenarioBatchRecord_H_
00013 #define DtScenarioBatchRecord_H_
00014 
00015 #include "vrfutil/rdrWritr.h"
00016 #include "vrfutil/rwInt.h"
00017 #include "vrfutil/rwString.h"
00018 #include "vrfutil/rwClockTime.h"
00019 #include <vlutil/vlFilename.h>
00020 #include "vrfutil/rwBoolean.h"
00021 
00027 
00028 #include "vrfutil/vrfutilDefines.h"
00029 class DT_DLL_vrfutil DtScenarioBatchRecord : public DtReaderWriter
00030 {
00031 public:
00032 
00034    DtScenarioBatchRecord();
00035 
00037    DtScenarioBatchRecord(const DtString& name,
00038       DtReaderWriterRegistry* const parentRegistry = NULL);
00039 
00040    DtScenarioBatchRecord(const DtSymbolString& name,
00041       DtReaderWriterRegistry* const parentRegistry = NULL);
00042 
00044    virtual ~DtScenarioBatchRecord();
00045 
00047    DtScenarioBatchRecord(const DtScenarioBatchRecord& orig, 
00048       DtReaderWriterRegistry* const parentRegistry = NULL);
00049 
00051    DtScenarioBatchRecord& operator=(const DtScenarioBatchRecord& orig);
00052 
00053    virtual DtScenarioBatchRecord * clone(DtReaderWriterRegistry* parentRegistry = NULL) const;
00054 
00056    virtual void setNumberOfRuns(int count);
00057    virtual int numberOfRuns() const;
00058 
00062    virtual void setRandomNumberSeedEntry(const int entry);
00063    virtual const int randomNumberSeedEntry() const;
00064 
00066    virtual void setScenarioFilename(const DtFilename& filename);
00067    virtual const DtFilename& scenarioFilename() const;
00068 
00070    virtual void setParameterFilename(const DtFilename& filename);
00071    virtual const DtFilename& parameterFilename() const;
00072 
00075    virtual void setRunDuration(const DtRwClockTime& duration);
00076    virtual const DtRwClockTime& runDuration() const;
00077 
00080    virtual void setSimulationRunDuration(const DtRwClockTime& duration);
00081    virtual const DtRwClockTime& simulationRunDuration() const;
00082 
00085    virtual void putSelf(FILE *fp, int indentLevel = 0, bool writeUnspecified = false,
00086       const DtFilename& path = DtReaderWriter::appPath());
00087    virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath,
00088       const DtVariableBindingsList& variableBindings);  
00089 
00092    virtual bool overrideRandomNumberSeed() const;
00093 
00095    virtual bool overrideParameterFile() const;
00096 
00098    virtual bool useSimulationDuration() const;
00099 
00100 protected:
00101 
00102    DtRwInt myNumberOfRuns;
00103    DtRwInt myRandomNumberSeedEntry;
00104    DtRwString myScenarioFileRwEntry;
00105    DtRwString myParameterFileRwEntry;
00106 
00108    DtRwClockTime mySimulationRunDuration;
00109    DtRwClockTime myRunDuration;
00110 
00111    DtFilename myScenarioFile;
00112    DtFilename myParameterFile;
00113 };
00114 
00115 #endif