Scippy

UG

Ubiquity Generator framework

class ParaParamString More...

#include <paraParamSet.h>

Inheritance diagram for ParaParamString:

Public Member Functions
	ParaParamString (const char name, const char inComment, const char *value)
	constructor More...

	~ParaParamString ()
	destructor More...

int	getType () const
	get parameter type More...

const char *	getDefaultValue () const
	get default value of this string parameter More...

const char *	getValue () const
	get current value of this string parameter More...

void	setDefaultValue ()
	set default value of this string parameter More...

void	setValue (const char *value)
	set current value of this sting parameter More...

bool	isDefaultValue () const
	check if current value is default value or not 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 string parameter value More...

const char *	currentValue
	current string parameter value More...

Detailed Description

class ParaParamString

Definition at line 754 of file paraParamSet.h.

Constructor & Destructor Documentation

◆ ParaParamString()

ParaParamString	(	const char *	name,
		const char *	inComment,
		const char *	value
	)

constructor

Parameters

name	string parameter name
inComment	comment string of this string parameter
value	default value of this string parameter

Definition at line 764 of file paraParamSet.h.

◆ ~ParaParamString()

~ParaParamString ( )

destructor

Definition at line 778 of file paraParamSet.h.

References ParaParamString::currentValue, and ParaParamString::defaultValue.

Member Function Documentation

◆ getDefaultValue()

const char * getDefaultValue ( ) const

get default value of this string parameter

Returns: default value

Definition at line 798 of file paraParamSet.h.

References ParaParamString::defaultValue.

Referenced by ParaParamSet::getStringParamDefaultValue().

◆ getType()

int getType ( ) const

virtual

get parameter type

Returns: 6: string

Implements ParaParam.

Definition at line 788 of file paraParamSet.h.

References UG::ParaParamTypeString.

◆ getValue()

const char * getValue ( ) const

get current value of this string parameter

Returns: current value

Definition at line 808 of file paraParamSet.h.

References ParaParamString::currentValue.

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

References ParaParamString::currentValue, and ParaParamString::defaultValue.

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

◆ setDefaultValue()

void setDefaultValue ( )

set default value of this string parameter

Definition at line 817 of file paraParamSet.h.

References ParaParamString::currentValue, and ParaParamString::defaultValue.

Referenced by ParaParamSet::setStringParamDefaultValue().

◆ setValue()

void setValue ( const char * value )

set current value of this sting parameter

Parameters

value value to be set

Definition at line 827 of file paraParamSet.h.

References ParaParamString::currentValue.

Referenced by ParaParamSet::paramParaseString(), ParaParamSetMpi::setDiffParams(), and ParaParamSet::setStringParamValue().

Member Data Documentation

◆ currentValue

const char* currentValue

private

current string parameter value

Definition at line 757 of file paraParamSet.h.

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

◆ defaultValue

const char* defaultValue

private

default string parameter value

Definition at line 756 of file paraParamSet.h.

Referenced by ParaParamString::getDefaultValue(), ParaParamString::isDefaultValue(), ParaParamString::setDefaultValue(), and ParaParamString::~ParaParamString().