ParaParamLongint Class Reference

class ParaParamLongint More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamLongint:

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

Detailed Description

class ParaParamLongint

Definition at line 412 of file paraParamSet.h.

Constructor & Destructor Documentation

ParaParamLongint()

ParaParamLongint	(	const char *	name,
		const char *	inComment,
		long long	value,
		const long long	min,
		const long long	max
	)

constructor

Parameters

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

Definition at line 424 of file paraParamSet.h.

~ParaParamLongint()

~ParaParamLongint

(

)

destructor

Definition at line 442 of file paraParamSet.h.

Member Function Documentation

getDefaultValue()

long long getDefaultValue

(

)

const

get default value of this long int parameter

Returns

default value

Definition at line 461 of file paraParamSet.h.

References ParaParamLongint::defaultValue.

Referenced by ParaParamSet::getLongintParamDefaultValue().

getMaxValue()

long long getMaxValue

(

)

const

get maximum value of this long

Definition at line 519 of file paraParamSet.h.

References ParaParamLongint::maxValue.

getMinValue()

long long getMinValue

(

)

const

get minimum value of this long int parameter

Returns

minimum value

Definition at line 510 of file paraParamSet.h.

References ParaParamLongint::minValue.

Referenced by ParaParamSet::paramParaseLongint().

getType()

int getType ( ) const

virtual

get parameter type

Returns

3: Long int

Implements ParaParam.

Definition at line 451 of file paraParamSet.h.

References UG::ParaParamTypeLongint.

getValue()

long long getValue

(

)

const

get current value of this long int parameter

Returns

current value

Definition at line 471 of file paraParamSet.h.

References ParaParamLongint::currentValue.

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

References ParaParamLongint::currentValue, and ParaParamLongint::defaultValue.

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

setDefaultValue()

void setDefaultValue

(

)

set default value of this long int parameter

Definition at line 480 of file paraParamSet.h.

References ParaParamLongint::currentValue, and ParaParamLongint::defaultValue.

Referenced by ParaParamSet::setLongintParamDefaultValue().

setValue()

void setValue

(

long long

value

)

set current value of this long int parameter

Parameters

value

value to be set

Definition at line 489 of file paraParamSet.h.

References ParaParamLongint::currentValue.

Referenced by ParaParamSet::paramParaseLongint(), ParaParamSetMpi::setDiffParams(), and ParaParamSet::setLongintParamValue().

Member Data Documentation

currentValue

long long currentValue

private

current long int parameter value

Definition at line 415 of file paraParamSet.h.

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

defaultValue

const long long defaultValue

private

default long int parameter value

Definition at line 414 of file paraParamSet.h.

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

maxValue

const long long maxValue

private

maximum long int parameter value

Definition at line 417 of file paraParamSet.h.

Referenced by ParaParamLongint::getMaxValue().

minValue

const long long minValue

private

minimum long int parameter value

Definition at line 416 of file paraParamSet.h.

Referenced by ParaParamLongint::getMinValue().