Minotaur 0.4.1
Docs for developers
Public Member Functions | List of all members
Minotaur::Environment Class Reference

#include <Environment.h>

Public Member Functions

 Environment ()
 Default constructor.
 
 ~Environment ()
 Destroy.
 
LoggerPtr getLogger () const
 Get the logger that is setup for the whole environment.
 
LogLevel getLogLevel () const
 Get the current log level.
 
TimergetNewTimer ()
 Get a new timer. The calling function has to free this timer.
 
OptionDBPtr getOptions ()
 Get the options database.
 
double getTime ()
 
const TimergetTimer ()
 Get the global timer. More...
 
double getWTime ()
 
const TimergetWTimer ()
 Get the global timer. More...
 
double timeLimit ()
 
std::string getVersion ()
 Get the version string.
 
void initRand ()
 Initialize random number generator. It reads the option value of rand_seed provided by the user, and sets the random seed using srand() function.
 
void readOptions (int argc, char **argv)
 Read the options using a char array that has 'argc' words in it.
 
void readOptions (const std::string &str)
 Read options from a string.
 
void setLogLevel (LogLevel l)
 Set the log level of the default logger.
 

Detailed Description

The environment is a container class that has pointers to the Logger, interrupt handler, timer factory and options that need to be passed to Minotaur.

Member Function Documentation

◆ getTime()

double Environment::getTime ( )

Get the time from the 'global timer' i.e. the total time consumed so far.

Parameters
[out]err0 if no error occured, positive otherwise.
Returns
The time used so far.

◆ getTimer()

const Timer * Environment::getTimer ( )

Get the global timer.

Returns
The timer used to query the time elapsed since the solver started.

◆ getWTimer()

const Timer * Environment::getWTimer ( )

Get the global timer.

Returns
The timer used to query the time elapsed since the solver started.

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

Minotaur source code documented by Doxygen 1.9.4 on Thu Apr 24 2025