Scippy

UG

Ubiquity Generator framework

ParaParamSetTh Class Reference

class ParaParamSetTh More...

#include <paraParamSetTh.h>

+ Inheritance diagram for ParaParamSetTh:

Public Member Functions

 ParaParamSetTh ()
 constructor More...
 
 ParaParamSetTh (int inNParaParams)
 constructor More...
 
 ~ParaParamSetTh ()
 destructor More...
 
int bcast (ParaComm *comm, int root)
 broadcast ParaParams More...
 
- Public Member Functions inherited from ParaParamSet
 ParaParamSet ()
 constructor More...
 
 ParaParamSet (size_t nInParaParams)
 constructor More...
 
virtual ~ParaParamSet ()
 destructor More...
 
bool getBoolParamValue (int param)
 

for bool parameters

More...
 
void setBoolParamValue (int param, bool value)
 set bool parameter value More...
 
bool getBoolParamDefaultValue (int param)
 get default value of bool parameter More...
 
void setBoolParamDefaultValue (int param)
 set bool parameter default value More...
 
bool isBoolParamDefaultValue (int param)
 check if bool parameter is default value or not More...
 
int getIntParamValue (int param)
 

for int parameters

More...
 
void setIntParamValue (int param, int value)
 set int parameter value More...
 
int getIntParamDefaultValue (int param)
 get default value of int parameter More...
 
void setIntParamDefaultValue (int param)
 set int parameter default value More...
 
bool isIntParamDefaultValue (int param)
 check if int parameter is default value or not More...
 
long long getLongintParamValue (int param)
 

for long int parameters

More...
 
void setLongintParamValue (int param, long long value)
 set long int parameter value More...
 
long long getLongintParamDefaultValue (int param)
 get default value of long int parameter More...
 
void setLongintParamDefaultValue (int param)
 set long int parameter default value More...
 
bool isLongintParamDefaultValue (int param)
 check if long int parameter is default value or not More...
 
double getRealParamValue (int param)
 

for real parameters

More...
 
void setRealParamValue (int param, double value)
 set real parameter value More...
 
double getRealParamDefaultValue (int param)
 get default value of real parameter More...
 
void setRealParamDefaultValue (int param)
 set real parameter default value More...
 
bool isRealParamDefaultValue (int param)
 check if real parameter is default value or not More...
 
char getCharParamValue (int param)
 

for char parameters

More...
 
void setCharParamValue (int param, char value)
 set char parameter value More...
 
char getCharParamDefaultValue (int param)
 get default value of char parameter More...
 
void setCharParamDefaultValue (int param)
 set char parameter default value More...
 
bool isCharParamDefaultValue (int param)
 check if char parameter is default value or not More...
 
const char * getStringParamValue (int param)
 

for char parameters

More...
 
void setStringParamValue (int param, const char *value)
 set string parameter value More...
 
const char * getStringParamDefaultValue (int param)
 get default value of string parameter More...
 
void setStringParamDefaultValue (int param)
 set string parameter default value More...
 
bool isStringParamDefaultValue (int param)
 check if string parameter is default value or not More...
 
virtual void read (ParaComm *comm, const char *filename)
 read ParaParams from file More...
 
void write (std::ostream *os)
 write ParaParams to output stream More...
 
size_t getParaParamsSize ()
 get parameter table size More...
 
virtual size_t getNumBoolParams ()=0
 get number of bool parameters More...
 
virtual size_t getNumIntParams ()=0
 get number of int parameters More...
 
virtual size_t getNumLongintParams ()=0
 get number of longint parameters More...
 
virtual size_t getNumRealParams ()=0
 get number of real parameters More...
 
virtual size_t getNumCharParams ()=0
 get number of char parameters More...
 
virtual size_t getNumStringParams ()=0
 get number of string parameters More...
 

Additional Inherited Members

- Protected Member Functions inherited from ParaParamSet
int paramParaseBool (ParaParam *paraParam, char *valuestr)
 parse bool parameter More...
 
int paramParaseInt (ParaParam *paraParam, char *valuestr)
 parse int parameter More...
 
int paramParaseLongint (ParaParam *paraParam, char *valuestr)
 parse long int parameter More...
 
int paramParaseReal (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int paramParaseChar (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int paramParaseString (ParaParam *paraParam, char *valuestr)
 parse real parameter More...
 
int parameterParse (char *line, std::map< std::string, int > &mapStringToId)
 parse parameter (this routine is almost copy from paramset.c of SCIP code) More...
 
- Protected Attributes inherited from ParaParamSet
size_t nParaParams
 number of ParaParams More...
 
ParaParam ** paraParams
 array of ParaParams More...
 

Detailed Description

class ParaParamSetTh

Definition at line 48 of file paraParamSetTh.h.

Constructor & Destructor Documentation

◆ ParaParamSetTh() [1/2]

constructor

Definition at line 56 of file paraParamSetTh.h.

◆ ParaParamSetTh() [2/2]

ParaParamSetTh ( int  inNParaParams)

constructor

Definition at line 64 of file paraParamSetTh.h.

◆ ~ParaParamSetTh()

destructor

Definition at line 74 of file paraParamSetTh.h.

Member Function Documentation

◆ bcast()

int bcast ( ParaComm comm,
int  root 
)
virtual

broadcast ParaParams

Returns
always 0 (for future extensions)
Parameters
commcommunicator used
rootroot rank for broadcast

Implements ParaParamSet.

Definition at line 83 of file paraParamSetTh.h.

References THROW_LOGICAL_ERROR1.