scenarioBatchRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfutil/readerWriter.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwClockTime.h"
#include <vlutil/vlFilename.h>
#include "vrfutil/rwBoolean.h"


#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtScenarioBatchRecord : public DtReaderWriter
{
public:

   DtScenarioBatchRecord();

   DtScenarioBatchRecord(const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL);

   DtScenarioBatchRecord(const DtSymbolString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL);

   virtual ~DtScenarioBatchRecord();

   DtScenarioBatchRecord(const DtScenarioBatchRecord& orig, 
      DtReaderWriterRegistry* const parentRegistry = NULL);

   DtScenarioBatchRecord& operator=(const DtScenarioBatchRecord& orig);

   virtual DtScenarioBatchRecord * clone(DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual void setNumberOfRuns(int count);
   virtual int numberOfRuns() const;

   virtual void setRandomNumberSeedEntry(const int entry);
   virtual const int randomNumberSeedEntry() const;

   virtual void setScenarioFilename(const DtFilename& filename);
   virtual const DtFilename& scenarioFilename() const;

   virtual void setSmsFilename(const DtFilename& filename);
   virtual const DtFilename& smsFilename() const;

   virtual void setRunDuration(const DtRwClockTime& duration);
   virtual const DtRwClockTime& runDuration() const;

   virtual void setSimulationRunDuration(const DtRwClockTime& duration);
   virtual const DtRwClockTime& simulationRunDuration() const;

   virtual void putSelf(std::string& fp, int indentLevel = 0, bool writeUnspecified = false,
      const DtFilename& path = DtReaderWriter::appPath());
   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);  

   virtual bool overrideRandomNumberSeed() const;

   virtual bool overrideSmsFile() const;

   virtual bool useSimulationDuration() const;

protected:

   DtRwInt myNumberOfRuns;
   DtRwInt myRandomNumberSeedEntry;
   DtRwString myScenarioFileRwEntry;
   DtRwString mySmsFileRwEntry;

   DtRwClockTime mySimulationRunDuration;
   DtRwClockTime myRunDuration;

   DtFilename myScenarioFile;
   DtFilename mySmsFile;
};