kome::core::CommonParameterManager Class Reference

common parameter manager class More...

#include <CommonParameterManager.h>

Classes
struct	ParamInfo
	parameter info More...

Public Member Functions
	CommonParameterManager ()
	constructor
virtual	~CommonParameterManager ()
	destructor
int	getNumberOfParameters ()
	gets the number of parameters variables More...
std::string	getParameterName (unsigned int index)
	gets parameters variable name More...
void	setParameter (std::string paramName, std::string paramValue, bool tempFlg)
	sets parameter More...
std::string	getParameter (std::string paramName, std::string defaultName)
	gets parameter More...
bool	isTemporaryParameter (unsigned int index)
	is temporary parameter More...

Static Public Member Functions
static CommonParameterManager &	getInstance ()
	gets common parameter management object. More...

Protected Attributes
std::vector< ParamInfo >	m_paramInfo

Detailed Description

common parameter manager class

Definition at line 25 of file CommonParameterManager.h.

Member Function Documentation

static CommonParameterManager & kome::core::CommonParameterManager::getInstance ( )

static

gets common parameter management object.

Returns

common parameter object. (This is the only object.)

Definition at line 122 of file CommonParameterManager.cpp.

                                                           {
    // create object (This is the only object.)
    static CommonParameterManager mgr;

    return mgr;
}

int kome::core::CommonParameterManager::getNumberOfParameters

(

)

gets the number of parameters variables

Returns

the number of parameters variables

Definition at line 43 of file CommonParameterManager.cpp.

                                                 {
    return m_paramInfo.size();
}

std::string kome::core::CommonParameterManager::getParameter	(	std::string	paramName,
		std::string	defaultName
	)

gets parameter

Parameters

[in]	paramName	parameters name
[in]	defaultName	parameters default name

Returns

parameter value (If the parameter info doesn't have value for specified name or value is empty, this method returns defaultName.)

Definition at line 98 of file CommonParameterManager.cpp.

                                                                                          {
    std::string str = defaultName;
    for( unsigned int i=0; i < m_paramInfo.size(); i++ ){
        if(  paramName.compare( m_paramInfo[i].paramName ) == 0 ){
            if( !m_paramInfo[i].paramValue.empty() ){
                str = m_paramInfo[i].paramValue;
            }
            break;
        }
    }
    
    return str;
}

std::string kome::core::CommonParameterManager::getParameterName

(

unsigned int

index

)

gets parameters variable name

Parameters

[in]

index

parameters variable index

Returns

parameter name (If the index is illegal, this method returns NULL.)

Definition at line 48 of file CommonParameterManager.cpp.

                                                                      { 
    if( index >= m_paramInfo.size() ) {
        return NULL;
    }

    return m_paramInfo[ index ].paramName;
}

bool kome::core::CommonParameterManager::isTemporaryParameter

(

unsigned int

index

)

is temporary parameter

Parameters

[in]

index

parameters variable index

Returns

true:is temporary parameter / false:in not temporary parameter

Definition at line 113 of file CommonParameterManager.cpp.

                                                                     {
    if( index >= m_paramInfo.size() ) {
        return true;
    }

    return m_paramInfo[ index ].tempFlg;
}

void kome::core::CommonParameterManager::setParameter	(	std::string	paramName,
		std::string	paramValue,
		bool	tempFlg
	)

sets parameter

Parameters

[in]	paramName	parameters name
[in]	paramValue	parameters value
[in]	tempFlg	temporary parameter flag

Definition at line 57 of file CommonParameterManager.cpp.

                                                                                                  {
    for( unsigned int i=0; i < m_paramInfo.size(); i++ ){
        if( paramName.compare( m_paramInfo[i].paramName ) == 0 ){
            return;
        }       
    }

    ParamInfo info;
    info.paramName = paramName;
    info.paramValue = paramValue;
    info.tempFlg = tempFlg;

    m_paramInfo.push_back( info );

    if( !tempFlg ){
        setIniString( paramName, paramValue );      
    }
}

Member Data Documentation

std::vector< ParamInfo > kome::core::CommonParameterManager::m_paramInfo

protected

parameters info

Definition at line 52 of file CommonParameterManager.h.

---

The documentation for this class was generated from the following files:

• CoreToolkits/CommonParameterManager.h
• CoreToolkits/CommonParameterManager.cpp