COPASI API  4.40.278
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
COptions Class Reference

#include <COptions.h>

Classes

class  COptionValue
 
class  COptionValueTemplate
 

Public Types

typedef std::map< std::string, std::string > defaultType
 
typedef std::vector< std::string > nonOptionType
 
typedef std::map< std::string, COptionValue * > optionType
 

Public Member Functions

 ~COptions ()
 

Static Public Member Functions

static void cleanup ()
 
template<class CType >
static bool compareValue (const std::string &name, const CType &value)
 
static std::string getConfigDir (void)
 
static std::string getEnvironmentVariable (const std::string &name)
 
static const nonOptionType & getNonOptions ()
 
static std::string getPWD (void)
 
template<class CType >
static void getValue (const std::string &name, CType &value)
 
static void init (C_INT argc=0, char *argv[]=NULL)
 
static bool isSet (const std::string &name)
 

Private Member Functions

 COptions ()
 

Static Private Member Functions

static std::string getConfigFile (void)
 
static std::string getCopasiDir (void)
 
static std::string getHome (void)
 
static std::string getTemp (void)
 
template<class CType >
static void setValue (const std::string &name, const CType &value)
 

Static Private Attributes

static nonOptionType mNonOptions
 
static optionType mOptions
 

Detailed Description

COptions class. The class retrieves the options from the commandline and various files. The options as well as their type can be retrieved by name.

Created for Copasi by Stefan Hoops 2002

Member Typedef Documentation

◆ defaultType

typedef std::map< std::string, std::string > COptions::defaultType

◆ nonOptionType

typedef std::vector< std::string > COptions::nonOptionType

◆ optionType

typedef std::map< std::string, COptionValue * > COptions::optionType

Constructor & Destructor Documentation

◆ COptions()

COptions::COptions ( )
private

References CONSTRUCTOR_TRACE.

◆ ~COptions()

COptions::~COptions ( )

References DESTRUCTOR_TRACE.

Member Function Documentation

◆ cleanup()

void COptions::cleanup ( )
static

References mOptions, and pdelete.

Referenced by CRootContainer::destroy().

◆ compareValue()

template<class CType >
static bool COptions::compareValue ( const std::string &  name,
const CType &  value 
)
inlinestatic

References isSet(), and mOptions.

Referenced by CCopasiMessage::handler(), and init().

◆ getConfigDir()

std::string COptions::getConfigDir ( void  )
static

References CDirEntry::createDir(), getValue(), and CDirEntry::Separator.

Referenced by init(), and loadDefaultStyles().

◆ getConfigFile()

std::string COptions::getConfigFile ( void  )
staticprivate

References getValue(), and CDirEntry::Separator.

Referenced by init().

◆ getCopasiDir()

std::string COptions::getCopasiDir ( void  )
staticprivate

References CDirEntry::dirName(), getEnvironmentVariable(), MCConfiguration, CCopasiMessage::RAW, and CLocaleString::toUtf8().

Referenced by init().

◆ getEnvironmentVariable()

std::string COptions::getEnvironmentVariable ( const std::string &  name)
static

References CLocaleString::fromUtf8(), and CLocaleString::toUtf8().

Referenced by getCopasiDir(), getHome(), and getTemp().

◆ getHome()

std::string COptions::getHome ( void  )
staticprivate

References getEnvironmentVariable(), and getTemp().

Referenced by init().

◆ getNonOptions()

const COptions::nonOptionType & COptions::getNonOptions ( )
static

References mNonOptions.

◆ getPWD()

std::string COptions::getPWD ( void  )
static

References free(), and CLocaleString::toUtf8().

Referenced by init(), and Copasi2SBMLTranslator::translateToSBML().

◆ getTemp()

std::string COptions::getTemp ( void  )
staticprivate

References CDirEntry::createDir(), getEnvironmentVariable(), CDirEntry::isDir(), CDirEntry::isWritable(), and CDirEntry::Separator.

Referenced by getHome(), and init().

◆ getValue()

template<class CType >
static void COptions::getValue ( const std::string &  name,
CType &  value 
)
inlinestatic

References isSet(), and mOptions.

Referenced by CRecentFiles::addFile(), CDataModel::autoSave(), CDataModel::exportCombineArchive(), CDataModel::exportSBML(), CDataModel::exportSEDML(), CDataModel::exportShinyArchive(), getConfigDir(), getConfigFile(), CDataModel::importSBML(), CDataModel::importSEDML(), init(), CConfigurationFile::load(), CConfigurationFile::CXML::load(), CDataModel::loadFromFile(), CDataModel::loadFromString(), CDataModel::loadModel(), CDirEntry::normalize(), CDataModel::openCombineArchive(), CConfigurationFile::save(), CDataModel::saveModel(), CDataModel::saveModelToString(), SEDMLUtils::setLibCombineTempDir(), Copasi2SBMLTranslator::translate(), CModelVersionHierarchy::updateVersionXML(), and WizardDialog::WizardDialog().

◆ init()

void COptions::init ( C_INT  argc = 0,
char *  argv[] = NULL 
)
static

References C_INT, compareValue(), copasi::options::ConfigDir, copasi::options::ConfigFile, copasi::options::ConvertToIrreversible, copasi::options::CopasiDir, CDirEntry::dirName(), CDirEntry::exist(), copasi::options::ExportBerkeleyMadonna, copasi::options::ExportC, copasi::options::ExportCombineArchive, copasi::options::ExportIni, copasi::options::ExportSBML, copasi::options::ExportSEDML, copasi::options::ExportXPPAUT, free(), copasi::COptionParser::get_non_options(), copasi::COptionParser::get_options(), getConfigDir(), getConfigFile(), getCopasiDir(), getHome(), getPWD(), getTemp(), getValue(), copasi::options::Home, copasi::options::ImportCombineArchive, copasi::options::ImportSBML, copasi::options::ImportSEDML, CDirEntry::isRelativePath(), copasi::options::License, CDirEntry::makePathAbsolute(), copasi::options::MaxTime, mNonOptions, copasi::options::NoLogo, copasi::COptionParser::parse(), copasi::options::PrintSedMLTasks, copasi::options::ReparameterizeModel, copasi::options::ReportFile, copasi::options::Save, copasi::options::SBMLSchema, copasi::options::ScheduledTask, copasi::options::SedmlTask, setValue(), copasi::options::Tmp, CLocaleString::toUtf8(), copasi::options::Validate, and copasi::options::Verbose.

Referenced by CRootContainer::init().

◆ isSet()

bool COptions::isSet ( const std::string &  name)
static

References mOptions.

Referenced by compareValue(), and getValue().

◆ setValue()

template<class CType >
static void COptions::setValue ( const std::string &  name,
const CType &  value 
)
inlinestaticprivate

References mOptions.

Referenced by init().

Member Data Documentation

◆ mNonOptions

COptions::nonOptionType COptions::mNonOptions
staticprivate

Referenced by getNonOptions(), and init().

◆ mOptions

COptions::optionType COptions::mOptions
staticprivate

Referenced by cleanup(), compareValue(), getValue(), isSet(), and setValue().

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