Scippy

UG

Ubiquity Generator framework

ParaParam Class Referenceabstract

class ParaParam More...

#include <paraParamSet.h>

Inheritance diagram for ParaParam:
ParaParamBool ParaParamChar ParaParamInt ParaParamLongint ParaParamReal ParaParamString

Public Member Functions

 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 * paramName
 parameter name More...
 
const char * comment
 comments for this parameter More...
 

Detailed Description

class ParaParam

Definition at line 141 of file paraParamSet.h.

Constructor & Destructor Documentation

◆ ParaParam()

ParaParam ( const char *  inParamName,
const char *  inComment 
)

constructor

Definition at line 151 of file paraParamSet.h.

◆ ~ParaParam()

virtual ~ParaParam ( )
virtual

destructor

Definition at line 163 of file paraParamSet.h.

Member Function Documentation

◆ getComment()

const char * getComment ( ) const

getter of comments string

Returns
string of comments

Definition at line 182 of file paraParamSet.h.

References ParaParam::comment.

Referenced by ParaParamSet::paramParaseChar(), ParaParamSet::paramParaseInt(), ParaParamSet::paramParaseLongint(), ParaParamSet::paramParaseReal(), and ParaParamSet::write().

◆ getParamName()

const char * getParamName ( ) const

◆ getType()

virtual int getType ( ) const
pure virtual

get parameter type

Returns
parameter type value

Implemented in ParaParamBool, ParaParamInt, ParaParamLongint, ParaParamReal, ParaParamChar, and ParaParamString.

Member Data Documentation

◆ comment

const char* comment
private

comments for this parameter

Definition at line 144 of file paraParamSet.h.

Referenced by ParaParam::getComment().

◆ paramName

const char* paramName
private

parameter name

Definition at line 143 of file paraParamSet.h.

Referenced by ParaParam::getParamName().