OpenM++ runtime library (libopenm)
openm::RunOptionsKey Struct Reference

keys for model run options More...

Static Public Attributes

static const char * subValueCount = "OpenM.SubValues"
 number of sub-values
 
static const char * runName = "OpenM.RunName"
 model run name in database
 
static const char * restartRunId = "OpenM.RestartRunId"
 model run id to restart model run
 
static const char * setId = "OpenM.SetId"
 working set id to get input parameters
 
static const char * setName = "OpenM.SetName"
 working set name to get input parameters
 
static const char * taskId = "OpenM.TaskId"
 modeling task id
 
static const char * taskName = "OpenM.TaskName"
 modeling task name
 
static const char * taskRunName = "OpenM.TaskRunName"
 modeling task run name in database
 
static const char * taskRunId = "OpenM.TaskRunId"
 modeling task run id
 
static const char * taskWait = "OpenM.TaskWait"
 modeling task under external supervision
 
static const char * profile = "OpenM.Profile"
 profile name to get run options
 
static const char * threadCount = "OpenM.Threads"
 number of modeling threads
 
static const char * notOnRoot = "OpenM.NotOnRoot"
 if true then do not run modeling threads at root process
 
static const char * dbConnStr = "OpenM.Database"
 database connection string
 
static const char * useSparse = "OpenM.SparseOutput"
 use sparse output tables
 
static const char * sparseNull = "OpenM.SparseNullValue"
 sparse null value More...
 
static const char * doubleFormat = "OpenM.DoubleFormat"
 convert to string format for float, double, long double
 
static const char * paramDir = "OpenM.ParamDir"
 dir/to/read/input/parameter.csv
 
static const char * useIdCsv = "OpenM.IdCsv"
 if true then parameter(s) csv file(s) contain enum id's, default: enum code
 
static const char * useIdParamValue = "OpenM.IdParameterValue"
 if true then parameter value is enum id, default: enum code
 
static const char * progressPercent = "OpenM.ProgressPercent"
 if positive then used for simulation progress reporting, ex: every 10%
 
static const char * progressStep = "OpenM.ProgressStep"
 if positive then used for simulation progress reporting, ex: every 1000 cases or every 0.1 time step
 
static const char * parameterPrefix = "Parameter"
 options started with "Parameter." treated as value of model scalar input parameter, ex: -Parameter.Age 42
 
static const char * subFromPrefix = "SubFrom"
 options started with "SubFrom." used to specify where to get sub-values of input parameter, ex: -SubFrom.Age csv
 
static const char * subValuesPrefix = "SubValues"
 options started with "SubValues." used specify sub-values of input parameter, ex: -SubValues.Age [1,4]
 
static const char * subGroupFromPrefix = "SubGroupFrom"
 options started with "SubGroupFrom." used to specify where to get sub-values for a group of input parameter, ex: -SubGroupFrom.Geo csv
 
static const char * subGroupValuesPrefix = "SubGroupValues"
 options started with "SubGroupValues." used specify sub-values for a group of input parameter, ex: -SubGroupValues.Geo [1,4]
 
static const char * importAll = "Import.All"
 import parameters from all upstream models last runs, ex: -Import.All true
 
static const char * importPrefix = "Import"
 options started with "Import." used to specify parameters import from upstream model run, ex: -Import.modelOne true
 
static const char * importRunDigestPrefix = "ImportRunDigest"
 options started with "ImportRunDigest." used to specify run name to import parameters from, ex: -ImportRunDigest.modelOne abcdef
 
static const char * importRunIdPrefix = "ImportRunId"
 options started with "ImportRunId." used to specify run id to import parameters from, ex: -ImportRunId.modelOne 101
 
static const char * importRunNamePrefix = "ImportRunName"
 options started with "ImportRunName." used to specify run name to import parameters from, ex: -ImportRunName.modelOne GoodRun
 
static const char * importModelDigestPrefix = "ImportModelDigest"
 options started with "ImportDigest." used to specify model digest to import parameters from last run of that model, ex: -ImportModelDigest.modelOne fedcba
 
static const char * importModelIdPrefix = "ImportModelId"
 options started with "ImportId." used to specify model id to import parameters from last run of that model, ex: -ImportModelId.modelOne 123
 
static const char * importExprPrefix = "ImportExpr"
 options started with "ImportExpr." used to specify expression name to import from output table, ex: -ImportExpr.AgeTable expr2
 
static const char * importDbPrefix = "ImportDb"
 options started with "ImportDatabase." used to specify database connection string to import parameters from, ex: -ImportDatabase.modelOne "Database=m1.sqlite;OpenMode=RedaOnly;"
 
static const char * traceToConsole = "OpenM.TraceToConsole"
 trace log to console
 
static const char * traceToFile = "OpenM.TraceToFile"
 trace log to file
 
static const char * traceFilePath = "OpenM.TraceFilePath"
 trace log file path
 
static const char * traceToStamped = "OpenM.TraceToStampedFile"
 trace log to "stamped" file
 
static const char * traceUseTs = "OpenM.TraceUseTimeStamp"
 trace use time-stamp in log "stamped" file name
 
static const char * traceUsePid = "OpenM.TraceUsePidStamp"
 trace use pid-stamp in log "stamped" file name
 
static const char * traceNoMsgTime = "OpenM.TraceNoMsgTime"
 do not prefix trace log messages with date-time
 
static const char * messageLang = "OpenM.MessageLanguage"
 language to display output messages
 
static const char * version = "OpenM.Version"
 log version info
 
static const char * dbSubValue = "db"
 sub-value of parameter must be in the input workset
 
static const char * iotaSubValue = "iota"
 sub-value of parameter created as integer from 0 to sub-value count
 
static const char * csvSubValue = "csv"
 all parameter sub-values must be in parameter.csv file
 
static const char * defaultValue = "default"
 default value for any option More...
 
static const char * allValue = "All"
 all value for any option
 

Detailed Description

keys for model run options

Member Data Documentation

◆ defaultValue

const char * openm::RunOptionsKey::defaultValue = "default"
static

default value for any option

default value of any option

◆ sparseNull

const char * openm::RunOptionsKey::sparseNull = "OpenM.SparseNullValue"
static

sparse null value

sparse NULL value


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