kome::core::Properties Class Reference

keys and values management class More...

#include <Properties.h>

Public Member Functions
	Properties ()
	constructor
virtual	~Properties ()
	destructor
void	setValue (const char *key, const char *value)
	sets parameter value More...
void	setIntValue (const char *key, int value)
	sets parameter value More...
void	setDoubleValue (const char *key, double value)
	sets parameter value More...
void	setBoolValue (const char *key, bool value)
	sets parameter value More...
void	setIntValues (const char *key, int *values, int size)
	set integer values More...
bool	hasKey (const char *key)
	judges whether this object has specified parameter key More...
const char *	getStringValue (const char *key, const char *defaultValue)
	gets parameter value More...
int	getIntValue (const char *key, int defaultValue)
	gets parameter value converted to integer More...
double	getDoubleValue (const char *key, double defaultValue)
	gets parameter value converted to double More...
bool	getBoolValue (const char *key, bool defaultValue)
	gets parameter value converted to bool More...
void	getIntValues (const char *key, std::vector< int > &values)
	gets integer values from comma separated values More...
unsigned int	getNumberOfProperties ()
	gets the number of Properties More...
const char *	getKey (const unsigned int index)
	gets the name of parameter More...
const char *	getValue (const unsigned int index)
	gets the parameter value More...
void	deleteParameter (const char *key)
	deletes parameter More...
std::string	replaceString (const char *s, const char *prefix, const char *suffix, const char *defaultString)
	replaces string "(prefix)(Property Key)(suffix)" to "(Property Value)" More...

Protected Attributes
std::vector< std::pair < std::string, std::string > >	m_props

Detailed Description

keys and values management class

Definition at line 29 of file Properties.h.

Member Function Documentation

void kome::core::Properties::deleteParameter

(

const char *

key

)

deletes parameter

Parameters

[in]

key

parameter key to be deleted

Definition at line 185 of file Properties.cpp.

                                                  {
    // create string object
    std::string k = std::string( NVL( key, "" ) );

    // search
    int idx = -1;
    for( unsigned int i = 0; i < m_props.size() && idx < 0; i++ ) {
        if( k.compare( m_props[ i ].first ) == 0 ) {
            idx = (int)i;
        }
    }

    // delete
    if( idx >= 0 ) {
        m_props.erase( m_props.begin() + idx );
    }
}

bool kome::core::Properties::getBoolValue	(	const char *	key,
		bool	defaultValue
	)

gets parameter value converted to bool

Parameters

[in]	key	parameter key
[in]	defaultValue	default value

Returns

parameter value converted to bool (If it is impossible to convert this parameter value to bool, this method returns default value.)

Definition at line 133 of file Properties.cpp.

                                                                  {
    return tobool( getStringValue( key, "" ), defaultValue );
}

Here is the call graph for this function:

double kome::core::Properties::getDoubleValue	(	const char *	key,
		double	defaultValue
	)

gets parameter value converted to double

Parameters

[in]	key	parameter key
[in]	defaultValue	default value

Returns

parameter value converted to double (If it is impossible to convert this parameter value to double, this method returns default value.)

Definition at line 128 of file Properties.cpp.

                                                                        {
    return todouble( getStringValue( key, "" ), defaultValue );
}

Here is the call graph for this function:

int kome::core::Properties::getIntValue	(	const char *	key,
		int	defaultValue
	)

gets parameter value converted to integer

Parameters

[in]	key	parameter key
[in]	defaultValue	default value

Returns

parameter value converted to integer (If it is impossible to convert this parameter value to integer, this method returns default value.)

Definition at line 123 of file Properties.cpp.

                                                               {
    return toint( getStringValue( key, "" ), 10, defaultValue );
}

Here is the call graph for this function:

void kome::core::Properties::getIntValues	(	const char *	key,
		std::vector< int > &	values
	)

gets integer values from comma separated values

Parameters

[in]	key	parameter key
[out]	values	stores integer value array

Definition at line 138 of file Properties.cpp.

  {
    // token
    std::vector<std::string> tokens;
    std::list< std::string > strValues;
    stringtoken(
        NVL( getStringValue( key, "" ), "" ),
        ", \t\r\n", tokens
    );

    // parse
    for (unsigned int i = 0; i< tokens.size(); i++) {
        int val = 0;
        if( isint( tokens[i].c_str(), 10, &val ) ) {
            values.push_back(val);
        }
    }
}

Here is the call graph for this function:

const char * kome::core::Properties::getKey

(

const unsigned int

index

)

gets the name of parameter

Parameters

[in]

index

key index

Returns

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

Definition at line 165 of file Properties.cpp.

                                                         {
    // check parameter
    if( index >= m_props.size() ) {
        return NULL;
    }

    return m_props[ index ].first.c_str();
}

unsigned int kome::core::Properties::getNumberOfProperties

(

)

gets the number of Properties

Returns

the number of Properties

Definition at line 160 of file Properties.cpp.

                                               {
    return m_props.size();
}

const char * kome::core::Properties::getStringValue	(	const char *	key,
		const char *	defaultValue
	)

gets parameter value

Parameters

[in]	key	parameter key
[in]	defaultValue	default value

Returns

parameter value. (If this object doesn't have specified key, this method returns default value.)

Definition at line 108 of file Properties.cpp.

                                                                                  {
    // string object
    std::string s = NVL( key, "" );

    // search
    for( unsigned int i = 0; i < m_props.size(); i++ ) {
        if( s.compare( m_props[ i ].first ) == 0 ) {
            return m_props[ i ].second.c_str();
        }
    }

    return defaultValue;
}

const char * kome::core::Properties::getValue

(

const unsigned int

index

)

gets the parameter value

Parameters

[in]

index

key index

Returns

the value of parameter (If index is illegal number, this method returns NULL)

Definition at line 175 of file Properties.cpp.

                                                           {
    // check parameter
    if( index >= m_props.size() ) {
        return NULL;
    }

    return m_props[ index ].second.c_str();
}

bool kome::core::Properties::hasKey

(

const char *

key

)

judges whether this object has specified parameter key

Parameters

[in]

key

parameter key

Returns

If there is specified parameter key, this method returns true.

Definition at line 93 of file Properties.cpp.

                                         {
    // create string object
    std::string s = NVL( key, "" );

    // search
    for( unsigned int i = 0; i < m_props.size(); i++ ) {
        if( s.compare( m_props[ i ].first ) == 0 ) {
            return true;
        }
    }

    return false;
}

std::string kome::core::Properties::replaceString	(	const char *	s,
		const char *	prefix,
		const char *	suffix,
		const char *	defaultString
	)

replaces string "(prefix)(Property Key)(suffix)" to "(Property Value)"

Parameters

[in]	s	character string
[in]	prefix	property key prefix
[in]	suffix	property key suffix
[in]	defaultString	the string to replace when specified key is not found

Definition at line 204 of file Properties.cpp.

  {
    // string
    std::string str;

    // check parameters
    if( s == NULL || prefix == NULL || suffix == NULL
            || *s == '\0' || *prefix == '\0' || *suffix == '\0' ) {
        return std::string( NVL( s, "" ) );
    }

    // copy to buffer
    char* buff = new char[ strlen( s ) + 1 ];
    memcpy( buff, s, strlen( s ) + 1 );

    // replace
    char* c = buff;
    bool keyFlag = false;

    while( c != NULL ) {
        if( keyFlag ) {     // search suffix
            char* cc = strstr( c, suffix );
            if( cc == NULL ) {      // suffix is not found
                str.append( prefix );
                str += std::string( c );
            }
            else {  // suffix is found
                std::string key = std::string( c, cc );
                if( hasKey( key.c_str() ) ) {
                    str.append( getStringValue( key.c_str(), "" ) );
                }
                else {
                    str.append( NVL( defaultString, "" ) );
                }
            }

            // change flag
            keyFlag = false;

            c = ( cc == NULL ) ? NULL : ( cc + strlen( suffix ) );
        }
        else {      // search prefix
            char* cc = strstr( c, prefix );
            if( cc == NULL ) {      // prefix is not found
                str += std::string( c );
            }
            else {  // prefix is found
                str += std::string( c, cc );
                keyFlag = true;
            }

            c = ( cc == NULL ) ? NULL : ( cc + strlen( prefix ) );
        }
    }

    // delete buff
    delete[] buff;

    return str;
}

Here is the call graph for this function:

void kome::core::Properties::setBoolValue	(	const char *	key,
		bool	value
	)

sets parameter value

Parameters

[in]	key	parameter key
[in]	value	parameter value

Definition at line 67 of file Properties.cpp.

                                                           {
    setValue( key, value ? "true" : "false" );
}

Here is the call graph for this function:

void kome::core::Properties::setDoubleValue	(	const char *	key,
		double	value
	)

sets parameter value

Parameters

[in]	key	parameter key
[in]	value	parameter value

Definition at line 62 of file Properties.cpp.

                                                               {
    setValue( key, FMT( "%f", value ).c_str() );
}

Here is the call graph for this function:

void kome::core::Properties::setIntValue	(	const char *	key,
		int	value
	)

sets parameter value

Parameters

[in]	key	parameter key
[in]	value	parameter value

Definition at line 57 of file Properties.cpp.

                                                         {
    setValue( key, FMT( "%d", value ).c_str() );
}

Here is the call graph for this function:

void kome::core::Properties::setIntValues	(	const char *	key,
		int *	values,
		int	size
	)

set integer values

Parameters

[in]	key	parameter key
[in]	values	array of integer values
[in]	size	values array size

Definition at line 72 of file Properties.cpp.

                                                                      {
    // check paramters
    if( values == NULL || size <= 0 ) {
        setValue( key, "" );
        return;
    }

    // create string
    std::string val;
    for( int i = 0; i < size; i++ ) {
        if( !val.empty() ) {
            val.append( "," );
        }
        val.append( FMT( "%d", values[ i ] ) );
    }

    // set value
    setValue( key, val.c_str() );
}

Here is the call graph for this function:

void kome::core::Properties::setValue	(	const char *	key,
		const char *	value
	)

sets parameter value

Parameters

[in]	key	parameter key
[in]	value	parameter value

Definition at line 39 of file Properties.cpp.

                                                              {
    // create string object
    std::string k = NVL( key, "" );
    std::string v = NVL( value, "" );

    // search
    for( unsigned int i = 0; i < m_props.size(); i++ ) {
        if( k.compare( m_props[ i ].first ) == 0 ) {
            m_props[ i ].second = v;
            return;
        }
    }

    // add
    m_props.push_back( std::make_pair( k, v ) );
}

Member Data Documentation

std::vector< std::pair< std::string, std::string > > kome::core::Properties::m_props

protected

properties

Definition at line 45 of file Properties.h.

---

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

• CoreToolkits/Properties.h
• CoreToolkits/Properties.cpp