ParaParamChar Class Reference

class ParaParamChar More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamChar:

Public Member Functions
	ParaParamChar (const char *name, const char *inComment, char value, const char *inAllowedValues)
	constructor More...
	~ParaParamChar ()
	destructor More...
int	getType () const
	get parameter type More...
char	getDefaultValue () const
	get default value of this char parameter More...
char	getValue () const
	get current value of this char parameter More...
void	setDefaultValue ()
	set default value of this char parameter More...
void	setValue (char value)
	set current value of this char parameter More...
bool	isDefaultValue () const
	check if current value is default value or not More...
const char *	getAllowedValues () const
	get all allowed char parameter values 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 char	defaultValue
	default char parameter value More...
char	currentValue
	current char parameter value More...
const char *	allowedValues
	allowed char parameter values More...

Detailed Description

class ParaParamChar

Definition at line 648 of file paraParamSet.h.

Constructor & Destructor Documentation

ParaParamChar()

ParaParamChar	(	const char *	name,
		const char *	inComment,
		char	value,
		const char *	inAllowedValues
	)

constructor

Parameters

name	char parameter name
inComment	comment string of this char parameter
value	default value of this char parameter
inAllowedValues	allowed char parameter values

Definition at line 659 of file paraParamSet.h.

~ParaParamChar()

~ParaParamChar

(

)

destructor

Definition at line 675 of file paraParamSet.h.

Member Function Documentation

getAllowedValues()

const char * getAllowedValues

(

)

const

get all allowed char parameter values

Returns

sting of allowed chars

Definition at line 743 of file paraParamSet.h.

References ParaParamChar::allowedValues.

Referenced by ParaParamSet::paramParaseChar().

getDefaultValue()

char getDefaultValue

(

)

const

get default value of this char parameter

Returns

default value

Definition at line 694 of file paraParamSet.h.

References ParaParamChar::defaultValue.

Referenced by ParaParamSet::getCharParamDefaultValue().

getType()

int getType ( ) const

virtual

get parameter type

Returns

5: char

Implements ParaParam.

Definition at line 684 of file paraParamSet.h.

References UG::ParaParamTypeChar.

getValue()

char getValue

(

)

const

get current value of this char parameter

Returns

current value

Definition at line 704 of file paraParamSet.h.

References ParaParamChar::currentValue.

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

References ParaParamChar::currentValue, and ParaParamChar::defaultValue.

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

setDefaultValue()

void setDefaultValue

(

)

set default value of this char parameter

Definition at line 713 of file paraParamSet.h.

References ParaParamChar::currentValue, and ParaParamChar::defaultValue.

Referenced by ParaParamSet::setCharParamDefaultValue().

setValue()

void setValue

(

char

value

)

set current value of this char parameter

Parameters

value

value to be set

Definition at line 722 of file paraParamSet.h.

References ParaParamChar::currentValue.

Referenced by ParaParamSet::paramParaseChar(), ParaParamSet::setCharParamValue(), and ParaParamSetMpi::setDiffParams().

Member Data Documentation

allowedValues

const char* allowedValues

private

allowed char parameter values

Definition at line 652 of file paraParamSet.h.

Referenced by ParaParamChar::getAllowedValues().

currentValue

char currentValue

private

current char parameter value

Definition at line 651 of file paraParamSet.h.

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

defaultValue

const char defaultValue

private

default char parameter value

Definition at line 650 of file paraParamSet.h.

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