OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Classes | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
oms::Flags Class Reference

#include <Flags.h>

Classes

struct  Flag
 

Static Public Member Functions

static oms_status_enu_t SetCommandLineOption (const std::string &cmd)
 
static bool AddParametersToCSV ()
 
static int CVODEMaxErrTestFails ()
 
static int CVODEMaxNLSFailures ()
 
static int CVODEMaxNLSIterations ()
 
static int CVODEMaxSteps ()
 
static bool DefaultModeIsCS ()
 
static bool DeleteTempFiles ()
 
static bool DirectionalDerivatives ()
 
static bool DumpAlgLoops ()
 
static bool EmitEvents ()
 
static bool IgnoreInitialUnknowns ()
 
static bool InputExtrapolation ()
 
static bool ProgressBar ()
 
static bool RealTime ()
 
static bool SkipCSVHeader ()
 
static bool SolverStats ()
 
static bool StripRoot ()
 
static bool SuppressPath ()
 
static bool WallTime ()
 
static bool ZeroNominal ()
 
static double InitialStepSize ()
 
static double MaximumStepSize ()
 
static double MinimumStepSize ()
 
static double StartTime ()
 
static double StopTime ()
 
static double Timeout ()
 
static double Tolerance ()
 
static oms_alg_solver_enu_t AlgLoopSolver ()
 
static oms_solver_enu_t MasterAlgorithm ()
 
static oms_solver_enu_t Solver ()
 
static std::string ResultFile ()
 
static unsigned int Intervals ()
 
static unsigned int MaxEventIteration ()
 
static unsigned int MaxLoopIteration ()
 
static unsigned int NumProcs ()
 

Private Member Functions

 Flags ()
 
 ~Flags ()
 
void setDefaults ()
 
 Flags (Flags const &)
 not implemented More...
 
Flagsoperator= (Flags const &)
 not implemented More...
 

Static Private Member Functions

static FlagsGetInstance ()
 
static oms_status_enu_t AddParametersToCSV (const std::string &value)
 
static oms_status_enu_t AlgLoopSolver (const std::string &value)
 
static oms_status_enu_t ClearAllOptions (const std::string &value)
 
static oms_status_enu_t CVODEMaxErrTestFails (const std::string &value)
 
static oms_status_enu_t CVODEMaxNLSFailures (const std::string &value)
 
static oms_status_enu_t CVODEMaxNLSIterations (const std::string &value)
 
static oms_status_enu_t CVODEMaxSteps (const std::string &value)
 
static oms_status_enu_t DeleteTempFiles (const std::string &value)
 
static oms_status_enu_t DirectionalDerivatives (const std::string &value)
 
static oms_status_enu_t DumpAlgLoops (const std::string &value)
 
static oms_status_enu_t EmitEvents (const std::string &value)
 
static oms_status_enu_t FetchAllVars (const std::string &value)
 
static oms_status_enu_t Filename (const std::string &value)
 
static oms_status_enu_t Help (const std::string &value)
 
static oms_status_enu_t IgnoreInitialUnknowns (const std::string &value)
 
static oms_status_enu_t InputExtrapolation (const std::string &value)
 
static oms_status_enu_t Intervals (const std::string &value)
 
static oms_status_enu_t LogFile (const std::string &value)
 
static oms_status_enu_t LogLevel (const std::string &value)
 
static oms_status_enu_t MaxEventIteration (const std::string &value)
 
static oms_status_enu_t MaxLoopIteration (const std::string &value)
 
static oms_status_enu_t Mode (const std::string &value)
 
static oms_status_enu_t NumProcs (const std::string &value)
 
static oms_status_enu_t ProgressBar (const std::string &value)
 
static oms_status_enu_t RealTime (const std::string &value)
 
static oms_status_enu_t ResultFile (const std::string &value)
 
static oms_status_enu_t SkipCSVHeader (const std::string &value)
 
static oms_status_enu_t Solver (const std::string &value)
 
static oms_status_enu_t SolverStats (const std::string &value)
 
static oms_status_enu_t StartTime (const std::string &value)
 
static oms_status_enu_t StepSize (const std::string &value)
 
static oms_status_enu_t StopTime (const std::string &value)
 
static oms_status_enu_t StripRoot (const std::string &value)
 
static oms_status_enu_t SuppressPath (const std::string &value)
 
static oms_status_enu_t TempDir (const std::string &value)
 
static oms_status_enu_t Timeout (const std::string &value)
 
static oms_status_enu_t Tolerance (const std::string &value)
 
static oms_status_enu_t Version (const std::string &value)
 
static oms_status_enu_t WallTime (const std::string &value)
 
static oms_status_enu_t WorkingDir (const std::string &value)
 
static oms_status_enu_t ZeroNominal (const std::string &value)
 

Private Attributes

bool addParametersToCSV
 
int cvodeMaxErrTestFails
 
int cvodeMaxNLSFails
 
int cvodeMaxNLSIterations
 
int cvodeMaxSteps
 
bool defaultModeIsCS
 
bool deleteTempFiles
 
bool directionalDerivatives
 
bool dumpAlgLoops
 
bool emitEvents
 
bool ignoreInitialUnknowns
 
bool inputExtrapolation
 
bool progressBar
 
bool realTime
 
bool skipCSVHeader
 
bool solverStats
 
bool stripRoot
 
bool suppressPath
 
bool wallTime
 
bool zeroNominal
 
double initialStepSize
 
double maximumStepSize
 
double minimumStepSize
 
double startTime
 
double stopTime
 
double timeout
 
double tolerance
 
oms_alg_solver_enu_t algLoopSolver
 
oms_solver_enu_t masterAlgorithm
 
oms_solver_enu_t solver
 
std::string resultFile
 
unsigned int intervals
 
unsigned int maxEventIteration
 
unsigned int maxLoopIteration
 
unsigned int numProcs
 
std::map< std::string, unsigned int > lookup
 
std::vector< std::string > files
 
const std::string re_void = ""
 
const std::string re_default = ".+"
 
const std::string re_bool = "(true|false)"
 
const std::string re_mode = "(me|cs)"
 
const std::string re_double = "((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?"
 
const std::string re_number = "[[:digit:]]+"
 
const std::string re_filename = ".+(\\.fmu|\\.ssp|\\.lua)"
 
const std::string re_stepSize = "((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?(,((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?,((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?)?"
 
const std::vector< Flagflags
 

Constructor & Destructor Documentation

◆ Flags() [1/2]

oms::Flags::Flags ( )
private

◆ ~Flags()

oms::Flags::~Flags ( )
private

◆ Flags() [2/2]

oms::Flags::Flags ( Flags const &  )
private

not implemented

Member Function Documentation

◆ AddParametersToCSV() [1/2]

static bool oms::Flags::AddParametersToCSV ( )
inlinestatic

◆ AddParametersToCSV() [2/2]

oms_status_enu_t oms::Flags::AddParametersToCSV ( const std::string &  value)
staticprivate

◆ AlgLoopSolver() [1/2]

static oms_alg_solver_enu_t oms::Flags::AlgLoopSolver ( )
inlinestatic

◆ AlgLoopSolver() [2/2]

oms_status_enu_t oms::Flags::AlgLoopSolver ( const std::string &  value)
staticprivate

◆ ClearAllOptions()

oms_status_enu_t oms::Flags::ClearAllOptions ( const std::string &  value)
staticprivate

◆ CVODEMaxErrTestFails() [1/2]

static int oms::Flags::CVODEMaxErrTestFails ( )
inlinestatic

◆ CVODEMaxErrTestFails() [2/2]

oms_status_enu_t oms::Flags::CVODEMaxErrTestFails ( const std::string &  value)
staticprivate

◆ CVODEMaxNLSFailures() [1/2]

static int oms::Flags::CVODEMaxNLSFailures ( )
inlinestatic

◆ CVODEMaxNLSFailures() [2/2]

oms_status_enu_t oms::Flags::CVODEMaxNLSFailures ( const std::string &  value)
staticprivate

◆ CVODEMaxNLSIterations() [1/2]

static int oms::Flags::CVODEMaxNLSIterations ( )
inlinestatic

◆ CVODEMaxNLSIterations() [2/2]

oms_status_enu_t oms::Flags::CVODEMaxNLSIterations ( const std::string &  value)
staticprivate

◆ CVODEMaxSteps() [1/2]

static int oms::Flags::CVODEMaxSteps ( )
inlinestatic

◆ CVODEMaxSteps() [2/2]

oms_status_enu_t oms::Flags::CVODEMaxSteps ( const std::string &  value)
staticprivate

◆ DefaultModeIsCS()

static bool oms::Flags::DefaultModeIsCS ( )
inlinestatic

◆ DeleteTempFiles() [1/2]

static bool oms::Flags::DeleteTempFiles ( )
inlinestatic

◆ DeleteTempFiles() [2/2]

oms_status_enu_t oms::Flags::DeleteTempFiles ( const std::string &  value)
staticprivate

◆ DirectionalDerivatives() [1/2]

static bool oms::Flags::DirectionalDerivatives ( )
inlinestatic

◆ DirectionalDerivatives() [2/2]

oms_status_enu_t oms::Flags::DirectionalDerivatives ( const std::string &  value)
staticprivate

◆ DumpAlgLoops() [1/2]

static bool oms::Flags::DumpAlgLoops ( )
inlinestatic

◆ DumpAlgLoops() [2/2]

oms_status_enu_t oms::Flags::DumpAlgLoops ( const std::string &  value)
staticprivate

◆ EmitEvents() [1/2]

static bool oms::Flags::EmitEvents ( )
inlinestatic

◆ EmitEvents() [2/2]

oms_status_enu_t oms::Flags::EmitEvents ( const std::string &  value)
staticprivate

◆ FetchAllVars()

oms_status_enu_t oms::Flags::FetchAllVars ( const std::string &  value)
staticprivate

◆ Filename()

oms_status_enu_t oms::Flags::Filename ( const std::string &  value)
staticprivate

◆ GetInstance()

oms::Flags & oms::Flags::GetInstance ( )
staticprivate

◆ Help()

oms_status_enu_t oms::Flags::Help ( const std::string &  value)
staticprivate

◆ IgnoreInitialUnknowns() [1/2]

static bool oms::Flags::IgnoreInitialUnknowns ( )
inlinestatic

◆ IgnoreInitialUnknowns() [2/2]

oms_status_enu_t oms::Flags::IgnoreInitialUnknowns ( const std::string &  value)
staticprivate

◆ InitialStepSize()

static double oms::Flags::InitialStepSize ( )
inlinestatic

◆ InputExtrapolation() [1/2]

static bool oms::Flags::InputExtrapolation ( )
inlinestatic

◆ InputExtrapolation() [2/2]

oms_status_enu_t oms::Flags::InputExtrapolation ( const std::string &  value)
staticprivate

◆ Intervals() [1/2]

static unsigned int oms::Flags::Intervals ( )
inlinestatic

◆ Intervals() [2/2]

oms_status_enu_t oms::Flags::Intervals ( const std::string &  value)
staticprivate

◆ LogFile()

oms_status_enu_t oms::Flags::LogFile ( const std::string &  value)
staticprivate

◆ LogLevel()

oms_status_enu_t oms::Flags::LogLevel ( const std::string &  value)
staticprivate

◆ MasterAlgorithm()

static oms_solver_enu_t oms::Flags::MasterAlgorithm ( )
inlinestatic

◆ MaxEventIteration() [1/2]

static unsigned int oms::Flags::MaxEventIteration ( )
inlinestatic

◆ MaxEventIteration() [2/2]

oms_status_enu_t oms::Flags::MaxEventIteration ( const std::string &  value)
staticprivate

◆ MaximumStepSize()

static double oms::Flags::MaximumStepSize ( )
inlinestatic

◆ MaxLoopIteration() [1/2]

static unsigned int oms::Flags::MaxLoopIteration ( )
inlinestatic

◆ MaxLoopIteration() [2/2]

oms_status_enu_t oms::Flags::MaxLoopIteration ( const std::string &  value)
staticprivate

◆ MinimumStepSize()

static double oms::Flags::MinimumStepSize ( )
inlinestatic

◆ Mode()

oms_status_enu_t oms::Flags::Mode ( const std::string &  value)
staticprivate

◆ NumProcs() [1/2]

static unsigned int oms::Flags::NumProcs ( )
inlinestatic

◆ NumProcs() [2/2]

oms_status_enu_t oms::Flags::NumProcs ( const std::string &  value)
staticprivate

◆ operator=()

Flags& oms::Flags::operator= ( Flags const &  )
private

not implemented

◆ ProgressBar() [1/2]

static bool oms::Flags::ProgressBar ( )
inlinestatic

◆ ProgressBar() [2/2]

oms_status_enu_t oms::Flags::ProgressBar ( const std::string &  value)
staticprivate

◆ RealTime() [1/2]

static bool oms::Flags::RealTime ( )
inlinestatic

◆ RealTime() [2/2]

oms_status_enu_t oms::Flags::RealTime ( const std::string &  value)
staticprivate

◆ ResultFile() [1/2]

static std::string oms::Flags::ResultFile ( )
inlinestatic

◆ ResultFile() [2/2]

oms_status_enu_t oms::Flags::ResultFile ( const std::string &  value)
staticprivate

◆ SetCommandLineOption()

oms_status_enu_t oms::Flags::SetCommandLineOption ( const std::string &  cmd)
static

◆ setDefaults()

void oms::Flags::setDefaults ( )
private

◆ SkipCSVHeader() [1/2]

static bool oms::Flags::SkipCSVHeader ( )
inlinestatic

◆ SkipCSVHeader() [2/2]

oms_status_enu_t oms::Flags::SkipCSVHeader ( const std::string &  value)
staticprivate

◆ Solver() [1/2]

static oms_solver_enu_t oms::Flags::Solver ( )
inlinestatic

◆ Solver() [2/2]

oms_status_enu_t oms::Flags::Solver ( const std::string &  value)
staticprivate

◆ SolverStats() [1/2]

static bool oms::Flags::SolverStats ( )
inlinestatic

◆ SolverStats() [2/2]

oms_status_enu_t oms::Flags::SolverStats ( const std::string &  value)
staticprivate

◆ StartTime() [1/2]

static double oms::Flags::StartTime ( )
inlinestatic

◆ StartTime() [2/2]

oms_status_enu_t oms::Flags::StartTime ( const std::string &  value)
staticprivate

◆ StepSize()

oms_status_enu_t oms::Flags::StepSize ( const std::string &  value)
staticprivate

◆ StopTime() [1/2]

static double oms::Flags::StopTime ( )
inlinestatic

◆ StopTime() [2/2]

oms_status_enu_t oms::Flags::StopTime ( const std::string &  value)
staticprivate

◆ StripRoot() [1/2]

static bool oms::Flags::StripRoot ( )
inlinestatic

◆ StripRoot() [2/2]

oms_status_enu_t oms::Flags::StripRoot ( const std::string &  value)
staticprivate

◆ SuppressPath() [1/2]

static bool oms::Flags::SuppressPath ( )
inlinestatic

◆ SuppressPath() [2/2]

oms_status_enu_t oms::Flags::SuppressPath ( const std::string &  value)
staticprivate

◆ TempDir()

oms_status_enu_t oms::Flags::TempDir ( const std::string &  value)
staticprivate

◆ Timeout() [1/2]

static double oms::Flags::Timeout ( )
inlinestatic

◆ Timeout() [2/2]

oms_status_enu_t oms::Flags::Timeout ( const std::string &  value)
staticprivate

◆ Tolerance() [1/2]

static double oms::Flags::Tolerance ( )
inlinestatic

◆ Tolerance() [2/2]

oms_status_enu_t oms::Flags::Tolerance ( const std::string &  value)
staticprivate

◆ Version()

oms_status_enu_t oms::Flags::Version ( const std::string &  value)
staticprivate

◆ WallTime() [1/2]

static bool oms::Flags::WallTime ( )
inlinestatic

◆ WallTime() [2/2]

oms_status_enu_t oms::Flags::WallTime ( const std::string &  value)
staticprivate

◆ WorkingDir()

oms_status_enu_t oms::Flags::WorkingDir ( const std::string &  value)
staticprivate

◆ ZeroNominal() [1/2]

static bool oms::Flags::ZeroNominal ( )
inlinestatic

◆ ZeroNominal() [2/2]

oms_status_enu_t oms::Flags::ZeroNominal ( const std::string &  value)
staticprivate

Member Data Documentation

◆ addParametersToCSV

bool oms::Flags::addParametersToCSV
private

◆ algLoopSolver

oms_alg_solver_enu_t oms::Flags::algLoopSolver
private

◆ cvodeMaxErrTestFails

int oms::Flags::cvodeMaxErrTestFails
private

◆ cvodeMaxNLSFails

int oms::Flags::cvodeMaxNLSFails
private

◆ cvodeMaxNLSIterations

int oms::Flags::cvodeMaxNLSIterations
private

◆ cvodeMaxSteps

int oms::Flags::cvodeMaxSteps
private

◆ defaultModeIsCS

bool oms::Flags::defaultModeIsCS
private

◆ deleteTempFiles

bool oms::Flags::deleteTempFiles
private

◆ directionalDerivatives

bool oms::Flags::directionalDerivatives
private

◆ dumpAlgLoops

bool oms::Flags::dumpAlgLoops
private

◆ emitEvents

bool oms::Flags::emitEvents
private

◆ files

std::vector<std::string> oms::Flags::files
private

◆ flags

const std::vector<Flag> oms::Flags::flags
private

◆ ignoreInitialUnknowns

bool oms::Flags::ignoreInitialUnknowns
private

◆ initialStepSize

double oms::Flags::initialStepSize
private

◆ inputExtrapolation

bool oms::Flags::inputExtrapolation
private

◆ intervals

unsigned int oms::Flags::intervals
private

◆ lookup

std::map<std::string, unsigned int> oms::Flags::lookup
private

◆ masterAlgorithm

oms_solver_enu_t oms::Flags::masterAlgorithm
private

◆ maxEventIteration

unsigned int oms::Flags::maxEventIteration
private

◆ maximumStepSize

double oms::Flags::maximumStepSize
private

◆ maxLoopIteration

unsigned int oms::Flags::maxLoopIteration
private

◆ minimumStepSize

double oms::Flags::minimumStepSize
private

◆ numProcs

unsigned int oms::Flags::numProcs
private

◆ progressBar

bool oms::Flags::progressBar
private

◆ re_bool

const std::string oms::Flags::re_bool = "(true|false)"
private

◆ re_default

const std::string oms::Flags::re_default = ".+"
private

◆ re_double

const std::string oms::Flags::re_double = "((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?"
private

◆ re_filename

const std::string oms::Flags::re_filename = ".+(\\.fmu|\\.ssp|\\.lua)"
private

◆ re_mode

const std::string oms::Flags::re_mode = "(me|cs)"
private

◆ re_number

const std::string oms::Flags::re_number = "[[:digit:]]+"
private

◆ re_stepSize

const std::string oms::Flags::re_stepSize = "((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?(,((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?,((\\+|-)?[[:digit:]]+)(\\.(([[:digit:]]+)?))?((e|E)((\\+|-)?)[[:digit:]]+)?)?"
private

◆ re_void

const std::string oms::Flags::re_void = ""
private

◆ realTime

bool oms::Flags::realTime
private

◆ resultFile

std::string oms::Flags::resultFile
private

◆ skipCSVHeader

bool oms::Flags::skipCSVHeader
private

◆ solver

oms_solver_enu_t oms::Flags::solver
private

◆ solverStats

bool oms::Flags::solverStats
private

◆ startTime

double oms::Flags::startTime
private

◆ stopTime

double oms::Flags::stopTime
private

◆ stripRoot

bool oms::Flags::stripRoot
private

◆ suppressPath

bool oms::Flags::suppressPath
private

◆ timeout

double oms::Flags::timeout
private

◆ tolerance

double oms::Flags::tolerance
private

◆ wallTime

bool oms::Flags::wallTime
private

◆ zeroNominal

bool oms::Flags::zeroNominal
private

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