Scippy

UG

Ubiquity Generator framework

ParaParamInt Class Reference

class ParaParamInt More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamInt:
ParaParam

Public Member Functions

 ParaParamInt (const char *name, const char *inComment, int value, const int min, const int max)
 contractor More...
 
 ~ParaParamInt ()
 destructor More...
 
int getType () const
 get parameter type More...
 
int getDefaultValue () const
 get default value of this int parameter More...
 
int getValue () const
 get current value of this int parameter More...
 
void setDefaultValue ()
 set default value More...
 
void setValue (int value)
 set current value More...
 
bool isDefaultValue () const
 check if current value is default value or not More...
 
int getMinValue () const
 get minimum value of this int parameter More...
 
int getMaxValue () const
 get maximum value of this int parameter More...
 
- Public Member Functions inherited from ParaParam
 ParaParam (const char *inParamName, const char *inComment)
 constructor More...
 
virtual ~ParaParam ()
 destructor More...
 
const char * getParamName () const
 getter of parameter name More...
 
const char * getComment () const
 getter of comments string More...
 
virtual int getType () const =0
 get parameter type More...
 

Private Attributes

const int defaultValue
 default int parameter value More...
 
int currentValue
 current int parameter value More...
 
const int minValue
 minimum int parameter value More...
 
const int maxValue
 maximum int parameter value More...
 

Detailed Description

class ParaParamInt

Definition at line 293 of file paraParamSet.h.

Constructor & Destructor Documentation

◆ ParaParamInt()

ParaParamInt ( const char *  name,
const char *  inComment,
int  value,
const int  min,
const int  max 
)

contractor

Parameters
nameint parameter name
inCommentcomment string of this int parameter
valuedefault value of this int parameter
minminimum value of this int parameter
maxmaximum value of this int parameter

Definition at line 305 of file paraParamSet.h.

◆ ~ParaParamInt()

destructor

Definition at line 323 of file paraParamSet.h.

Member Function Documentation

◆ getDefaultValue()

int getDefaultValue ( ) const

get default value of this int parameter

Returns
default value

Definition at line 342 of file paraParamSet.h.

References ParaParamInt::defaultValue.

Referenced by ParaParamSet::getIntParamDefaultValue().

◆ getMaxValue()

int getMaxValue ( ) const

get maximum value of this int parameter

Returns
maximum value

Definition at line 401 of file paraParamSet.h.

References ParaParamInt::maxValue.

◆ getMinValue()

int getMinValue ( ) const

get minimum value of this int parameter

Returns
minimum value

Definition at line 391 of file paraParamSet.h.

References ParaParamInt::minValue.

Referenced by ParaParamSet::paramParaseInt().

◆ getType()

int getType ( ) const
virtual

get parameter type

Returns
2: Int

Implements ParaParam.

Definition at line 332 of file paraParamSet.h.

References UG::ParaParamTypeInt.

◆ getValue()

int getValue ( ) const

get current value of this int parameter

Returns
current value

Definition at line 352 of file paraParamSet.h.

References ParaParamInt::currentValue.

Referenced by ParaParamSetMpi::createDiffParams(), ParaParamSet::getIntParamValue(), and ParaParamSet::write().

◆ isDefaultValue()

bool isDefaultValue ( ) const

check if current value is default value or not

Returns
true if current value is default value

Definition at line 381 of file paraParamSet.h.

References ParaParamInt::currentValue, and ParaParamInt::defaultValue.

Referenced by ParaParamSetMpi::createDiffParams(), ParaParamSet::isIntParamDefaultValue(), and ParaParamSet::write().

◆ setDefaultValue()

void setDefaultValue ( )

set default value

Definition at line 361 of file paraParamSet.h.

References ParaParamInt::currentValue, and ParaParamInt::defaultValue.

Referenced by ParaParamSet::setIntParamDefaultValue().

◆ setValue()

void setValue ( int  value)

set current value

Parameters
valueint value to be set

Definition at line 370 of file paraParamSet.h.

References ParaParamInt::currentValue.

Referenced by ParaParamSet::paramParaseInt(), ParaParamSetMpi::setDiffParams(), and ParaParamSet::setIntParamValue().

Member Data Documentation

◆ currentValue

int currentValue
private

current int parameter value

Definition at line 296 of file paraParamSet.h.

Referenced by ParaParamInt::getValue(), ParaParamInt::isDefaultValue(), ParaParamInt::setDefaultValue(), and ParaParamInt::setValue().

◆ defaultValue

const int defaultValue
private

default int parameter value

Definition at line 295 of file paraParamSet.h.

Referenced by ParaParamInt::getDefaultValue(), ParaParamInt::isDefaultValue(), and ParaParamInt::setDefaultValue().

◆ maxValue

const int maxValue
private

maximum int parameter value

Definition at line 298 of file paraParamSet.h.

Referenced by ParaParamInt::getMaxValue().

◆ minValue

const int minValue
private

minimum int parameter value

Definition at line 297 of file paraParamSet.h.

Referenced by ParaParamInt::getMinValue().