8.5.15. MDOEnv

class MDOEnv

表示MindOpt运行时环境

方法

MDOEnv	构造一个环境
MDOEnv	使用关联的日志文件构造环境
MDOEnv	使用关联的日志文件构造环境
get	检索int参数的值
get	检索double参数的值
get	检索字符串参数的值
getErrorMsg	检索最新的错误信息
getParamInfo	按其名称检索有关double参数的信息
getParamInfo	通过其名称检索有关int参数的信息
getParamInfo	按名称检索有关String参数的信息
message	将消息追加到环境日志中
readParams	从文件中读取参数设置
resetParams	将所有参数重置为其默认值
set	为int参数设置新值
set	为double参数设置新值
set	为String参数设置新值
set	为参数设置新值
start	如果该环境状态为空（‘empty’），则启动该环境，否则不执行任何操作
writeParams	将参数设置写入文件

MDOEnv(const bool empty = false)

构造一个环境

Parameters

const bool empty=false – 是否构造一个空的环境

MDOEnv(const char *logfilename)

使用关联的日志文件构造环境

Parameters

const char* logfilename – 与环境关联的日志文件名。可以为NULL或空字符串，但在这种情况下，将不会创建日志文件

MDOEnv(const std::string &logfilename)

使用关联的日志文件构造环境

Parameters

const std::string& logfilename – 与环境关联的日志文件名。可以是空字符串，但在这种情况下，将不会创建日志文件

int get(MDO_IntParam param)

检索int参数的值

Parameters

MDO_IntParam param – 参数名称

Returns

参数的当前值

double get(MDO_DoubleParam param)

检索double参数的值

Parameters

MDO_DoubleParam param – 参数名称

Returns

参数的当前值

std::string get(MDO_StringParam param)

检索字符串参数的值

Parameters

MDO_StringParam param – 参数名称

Returns

参数的当前值

const std::string getErrorMsg()

检索最新的错误信息

Returns

最新的错误信息

void getParamInfo(MDO_DoubleParam param, double *valP, double *minP, double *maxP, double *defP)

按其名称检索有关double参数的信息

Parameters

• MDO_DoubleParam param – 参数名称

• double* valP – 保存参数当前值的位置

• double* minP – 保存参数的最小允许值的位置

• double* maxP – 保存参数的最大允许值的位置

• double* defP – 保存参数默认值的位置

void getParamInfo(MDO_IntParam param, int *valP, int *minP, int *maxP, int *defP)

通过其名称检索有关int参数的信息

Parameters

• MDO_IntParam param – 参数名称

• int* valP – 保存参数当前值的位置

• int* minP – 保存参数的最小允许值的位置

• int* maxP – 保存参数的最大允许值的位置

• int* defP – 保存参数默认值的位置

void getParamInfo(MDO_StringParam param, std::string &value, std::string &defvalue)

按名称检索有关String参数的信息

Parameters

• MDO_StringParam param – 参数名称

• std::string& value – 保存参数当前值的位置

• std::string& defvalue – 保存参数默认值的位置

void message(const std::string &msg)

将消息追加到环境日志中

Parameters

const std::string& msg – 要追加的消息

void readParams(const std::string &paramfile)

从文件中读取参数设置

Parameters

const std::string& paramfile – 被读取的文件名。请注意，文件格式和压缩类型应编码为文件名中的后缀。有效的文件格式为.prm，支持的压缩类型包括.gz和.Bz2。

void resetParams()

将所有参数重置为其默认值

void set(MDO_IntParam param, int newvalue)

为int参数设置新值

Parameters

• MDO_IntParam param – 参数名称

• int newvalue – 要设置的新值

void set(MDO_DoubleParam param, double newvalue)

为double参数设置新值

Parameters

• MDO_DoubleParam param – 参数名称

• double newvalue – 要设置的新值

void set(MDO_StringParam param, const std::string &newvalue)

为String参数设置新值

Parameters

• MDO_StringParam param – 参数名称

• const std::string& newvalue – 要设置的新值

void set(const std::string &paramname, const std::string &newvalue)

为参数设置新值

Parameters

• const std::string& paramname – 参数名称

• const std::string& newvalue – 要设置的新值的字符串表示形式，其实际值取决于name指定的参数类型

void start()

如果该环境状态为空（‘empty’），则启动该环境，否则不执行任何操作

void writeParams(const std::string &paramfile)

将参数设置写入文件

Parameters

const std::string& paramfile – 被写入的文件名。请注意，文件格式和压缩类型应编码为文件名中的后缀。有效的文件格式为.prm，支持的压缩类型包括.gz和.Bz2。