ParaParamReal Class Reference

class ParaParamReal More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamReal:

Public Member Functions
	ParaParamReal (const char *name, const char *inComment, double value, const double min, const double max)
	constructor More...
	~ParaParamReal ()
	destructor More...
int	getType () const
	get parameter type More...
double	getDefaultValue () const
	get default value of this real parameter More...
double	getValue () const
	get current value of this real parameter More...
void	setDefaultValue ()
	set default value of this real parameter More...
void	setValue (double value)
	set current value of this real parameter More...
bool	isDefaultValue () const
	check if current value is default value or not More...
double	getMinValue () const
	get minimum value of this long int parameter More...
double	getMaxValue () const
	get maximum value of this long 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 double	defaultValue
	default real parameter value More...
double	currentValue
	current real parameter value More...
const double	minValue
	minimum real parameter value More...
const double	maxValue
	maximum real parameter value More...

Detailed Description

class ParaParamReal

Definition at line 530 of file paraParamSet.h.

Constructor & Destructor Documentation

ParaParamReal()

ParaParamReal	(	const char *	name,
		const char *	inComment,
		double	value,
		const double	min,
		const double	max
	)

constructor

Parameters

name	real parameter name
inComment	comment string of this real parameter
value	default value of this real parameter
min	minimum value of this real parameter
max	maximum value of this real parameter

Definition at line 542 of file paraParamSet.h.

~ParaParamReal()

~ParaParamReal

(

)

destructor

Definition at line 560 of file paraParamSet.h.

Member Function Documentation

getDefaultValue()

double getDefaultValue

(

)

const

get default value of this real parameter

Returns

default value

Definition at line 579 of file paraParamSet.h.

References ParaParamReal::defaultValue.

Referenced by ParaParamSet::getRealParamDefaultValue().

getMaxValue()

double getMaxValue

(

)

const

get maximum value of this long

Definition at line 637 of file paraParamSet.h.

References ParaParamReal::maxValue.

getMinValue()

double getMinValue

(

)

const

get minimum value of this long int parameter

Returns

minimum value

Definition at line 628 of file paraParamSet.h.

References ParaParamReal::minValue.

Referenced by ParaParamSet::paramParaseReal().

getType()

int getType ( ) const

virtual

get parameter type

Returns

4: real

Implements ParaParam.

Definition at line 569 of file paraParamSet.h.

References UG::ParaParamTypeReal.

getValue()

double getValue

(

)

const

get current value of this real parameter

Returns

current value

Definition at line 589 of file paraParamSet.h.

References ParaParamReal::currentValue.

Referenced by ParaParamSetMpi::createDiffParams(), ParaParamSet::getRealParamValue(), 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 618 of file paraParamSet.h.

References ParaParamReal::currentValue, and ParaParamReal::defaultValue.

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

setDefaultValue()

void setDefaultValue

(

)

set default value of this real parameter

Definition at line 598 of file paraParamSet.h.

References ParaParamReal::currentValue, and ParaParamReal::defaultValue.

Referenced by ParaParamSet::setRealParamDefaultValue().

setValue()

void setValue

(

double

value

)

set current value of this real parameter

Parameters

value

value to be set

Definition at line 607 of file paraParamSet.h.

References ParaParamReal::currentValue.

Referenced by ParaParamSet::paramParaseReal(), ParaParamSetMpi::setDiffParams(), and ParaParamSet::setRealParamValue().

Member Data Documentation

currentValue

double currentValue

private

current real parameter value

Definition at line 533 of file paraParamSet.h.

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

defaultValue

const double defaultValue

private

default real parameter value

Definition at line 532 of file paraParamSet.h.

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

maxValue

const double maxValue

private

maximum real parameter value

Definition at line 535 of file paraParamSet.h.

Referenced by ParaParamReal::getMaxValue().

minValue

const double minValue

private

minimum real parameter value

Definition at line 534 of file paraParamSet.h.

Referenced by ParaParamReal::getMinValue().