openm::RunOptionsKey Struct Reference

keys for model run options More...

#include <metaLoader.h>

Static Public Attributes
static constexpr const char *	subValueCount = "OpenM.SubValues"
	number of sub-values
static constexpr const char *	runName = "OpenM.RunName"
	model run name in database
static constexpr const char *	runId = "OpenM.RunId"
	read-only option, current model run id
static constexpr const char *	runCreated = "OpenM.RunCreated"
	read-only option, current model run create timestamp, ex: 2018_11_10_22_47_46_076
static constexpr const char *	restartRunId = "OpenM.RestartRunId"
	model run id to restart model run
static constexpr const char *	setId = "OpenM.SetId"
	working set id to get input parameters
static constexpr const char *	setName = "OpenM.SetName"
	working set name to get input parameters
static constexpr const char *	baseRunName = "OpenM.BaseRunName"
	base run name to get input parameters
static constexpr const char *	baseRunId = "OpenM.BaseRunId"
	model run id to get input parameters
static constexpr const char *	baseRunDigest = "OpenM.BaseRunDigest"
	model run digest to get input parameters
static constexpr const char *	taskId = "OpenM.TaskId"
	modeling task id
static constexpr const char *	taskName = "OpenM.TaskName"
	modeling task name
static constexpr const char *	taskRunName = "OpenM.TaskRunName"
	modeling task run name in database
static constexpr const char *	taskRunId = "OpenM.TaskRunId"
	read-only option, modeling task run id
static constexpr const char *	taskWait = "OpenM.TaskWait"
	modeling task under external supervision
static constexpr const char *	profile = "OpenM.Profile"
	profile name to get run options
static constexpr const char *	threadCount = "OpenM.Threads"
	number of modeling threads
static constexpr const char *	notOnRoot = "OpenM.NotOnRoot"
	if true then do not run modeling threads at root process
static constexpr const char *	dbConnStr = "OpenM.Database"
	database connection string
static constexpr const char *	dbSqlite = "OpenM.Sqlite"
	SQLite database file path.
static constexpr const char *	dbFromBin = "OpenM.SqliteFromBin"
	SQLite database file is: directory/of/model/exe/ModelName.sqlite.
static constexpr const char *	useSparse = "OpenM.SparseOutput"
	OBSOLETE, for backward compatibility only. More...
static constexpr const char *	sparseNull = "OpenM.SparseNullValue"
	OBSOLETE, for backward compatibility only. More...
static constexpr const char *	doubleFormat = "OpenM.DoubleFormat"
	convert to string format for float, double, long double
static constexpr const char *	paramDir = "OpenM.ParamDir"
	dir/to/read/input/parameter.csv, it can be any of: .csv .tsv .id.csv .id.tsv file.
static constexpr const char *	useIdCsv = "OpenM.IdCsv"
	if true then parameter(s) csv file(s) contain enum id's, default: enum code
static constexpr const char *	useIdParamValue = "OpenM.IdParameterValue"
	if true then parameter value is enum id, default: enum code
static constexpr const char *	progressPercent = "OpenM.ProgressPercent"
	if positive then used for simulation progress reporting, ex: every 10%
static constexpr const char *	progressStep = "OpenM.ProgressStep"
	if positive then used for simulation progress reporting, ex: every 1000 cases or every 0.1 time step
static constexpr const char *	parameterPrefix = "Parameter"
	options started with "Parameter." treated as value of model scalar input parameter, ex: -Parameter.Age 42
static constexpr const char *	subFromPrefix = "SubFrom"
	options started with "SubFrom." used to specify where to get sub-values of input parameter or group of parameters, ex: -SubFrom.Age csv
static constexpr const char *	subValuesPrefix = "SubValues"
	options started with "SubValues." used specify sub-values of input parameter or group of parameters, ex: -SubValues.Age [1,4]
static constexpr const char *	tableSuppress = "Tables.Suppress"
	exclude output tables or tables group from run results, ex: -Tables.Suppress AgeTable,IncomeGroup
static constexpr const char *	tableRetain = "Tables.Retain"
	include only specified output tables or tables group into run results, ex: -Tables.Retain AgeTable,IncomeGroup
static constexpr const char *	microdataToDb = "Microdata.ToDb"
	store entity microdata in database, ex: -Microdata.ToDb true
static constexpr const char *	microdataToCsv = "Microdata.ToCsv"
	write entity microdata into CSV file, ex: -Microdata.ToCsv true
static constexpr const char *	microdataToTrace = "Microdata.ToTrace"
	write entity microdata into trace output, ex: -Microdata.ToTrace true
static constexpr const char *	microdataCsvDir = "Microdata.CsvDir"
	write entity microdata into CSV file, ex: -Microdata.CsvDir csv/output/dir
static constexpr const char *	microdataAll = "Microdata.All"
	store all entities and all non-internal attributes, ex: -Microdata.All true
static constexpr const char *	microdataInternal = "Microdata.UseInternal"
	allow to use internal attributes, ex: -Microdata.UseInternal true
static constexpr const char *	microdataEvents = "Microdata.Events"
	filter entity events, ex: -Microdata.Events Birth,Union or -Microdata.Events All
static constexpr const char *	microdataEventColumn = "Microdata.CsvEventColumn"
	if true then write event names in CSV file, ex: -Microdata.CsvEventColumn true
static constexpr const char *	microdataPrefix = "Microdata"
	options started with "Microdata." used to specify which entity attributes to store, ex: -Microdata.Person age,region,income
static constexpr const char *	importAll = "Import.All"
	options started with "MicrodataFilter." used to specify which entity filters, ex: -MicrodataFilter.Person age >= 65 More...
static constexpr const char *	importPrefix = "Import"
	options started with "Import." used to specify parameters import from upstream model run, ex: -Import.modelOne true
static constexpr const char *	importRunDigestPrefix = "ImportRunDigest"
	options started with "ImportRunDigest." used to specify run name to import parameters from, ex: -ImportRunDigest.modelOne abcdef
static constexpr const char *	importRunIdPrefix = "ImportRunId"
	options started with "ImportRunId." used to specify run id to import parameters from, ex: -ImportRunId.modelOne 101
static constexpr const char *	importRunNamePrefix = "ImportRunName"
	options started with "ImportRunName." used to specify run name to import parameters from, ex: -ImportRunName.modelOne GoodRun
static constexpr 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 constexpr 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 constexpr const char *	importExprPrefix = "ImportExpr"
	options started with "ImportExpr." used to specify expression name to import from output table, ex: -ImportExpr.AgeTable expr2
static constexpr const char *	importDbPrefix = "ImportDb"
	options started with "ImportDb." used to specify database connection string to import parameters from, ex: -ImportDb.modelOne "Database=m1.sqlite;OpenMode=RedaOnly;"
static constexpr const char *	runDescrSuffix = "RunDescription"
	options ended with ".RunDescription" used to specify run decsription, ex: -EN.RunDescription "run model with 50,000 cases"
static constexpr const char *	runNotePathSuffix = "RunNotesPath"
	options ended with ".RunNotesPath" used to specify path to run notes file, ex: -EN.RunNotesPath EN_notes.md
static constexpr const char *	traceToConsole = "OpenM.TraceToConsole"
	trace log to console
static constexpr const char *	traceToFile = "OpenM.TraceToFile"
	trace log to file
static constexpr const char *	traceFilePath = "OpenM.TraceFilePath"
	trace log file path
static constexpr const char *	traceToStamped = "OpenM.TraceToStampedFile"
	trace log to "stamped" file
static constexpr const char *	traceUseTs = "OpenM.TraceUseTimeStamp"
	trace use time-stamp in log "stamped" file name
static constexpr const char *	traceUsePid = "OpenM.TraceUsePidStamp"
	trace use pid-stamp in log "stamped" file name
static constexpr const char *	traceNoMsgTime = "OpenM.TraceNoMsgTime"
	do not prefix trace log messages with date-time
static constexpr const char *	traceRank = "OpenM.TraceRank"
	trace use process rank as log message prefix
static constexpr const char *	logRank = "OpenM.LogRank"
	use process rank as log message prefix
static constexpr const char *	messageLang = "OpenM.MessageLanguage"
	language to display output messages
static constexpr const char *	dbSubValue = "db"
	sub-value of parameter must be in the input workset
static constexpr const char *	iotaSubValue = "iota"
	sub-value of parameter created as integer from 0 to sub-value count
static constexpr const char *	csvSubValue = "csv"
	all parameter sub-values must be in parameter csv file
static constexpr const char *	defaultValue = "default"
	default value for any option
static constexpr const char *	allValue = "All"
	all value for any option

Detailed Description

keys for model run options

Member Data Documentation

importAll

constexpr const char* openm::RunOptionsKey::importAll = "Import.All"

staticconstexpr

options started with "MicrodataFilter." used to specify which entity filters, ex: -MicrodataFilter.Person age >= 65

import parameters from all upstream models last runs, ex: -Import.All true

sparseNull

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

staticconstexpr

OBSOLETE, for backward compatibility only.

sparse null value

useSparse

constexpr const char* openm::RunOptionsKey::useSparse = "OpenM.SparseOutput"

staticconstexpr

OBSOLETE, for backward compatibility only.

use sparse output tables

---

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

• include/metaLoader.h