kome::objects::SettingParameterValues Class Reference

setting parameter values management class More...

#include <SettingParameterValues.h>

Classes
struct	SubSettingsKey
	sub settings key More...

Public Member Functions
	SettingParameterValues ()
	constructor
	SettingParameterValues (const SettingParameterValues &other)
	copy constructor More...
virtual	~SettingParameterValues ()
	destructor
SettingParameterValues &	operator= (const SettingParameterValues &other)
	the definition of assignment operator More...
void	clear ()
	clears parameters
void	setValue (const unsigned int index, const char *value)
	sets parameter value More...
void	setValue (const char *name, const char *value)
	sets parameter value More...
unsigned int	getNumberOfParameters ()
	gets the number of parameters More...
const char *	getParameterName (const unsigned int index)
	gets parameter name More...
const char *	getParameterValue (const unsigned int index)
	gets parameter value More...
const char *	getParameterValue (const char *name)
	gets parameter value More...
bool	getBoolValue (const unsigned int index, const bool df)
	gets boolean value More...
bool	getBoolValue (const char *name, const bool df)
	gets boolean value More...
int	getIntValue (const unsigned int index, const int df)
	gets integer value More...
int	getIntValue (const char *name, const int df)
	gets integer value More...
double	getDoubleValue (const unsigned int index, const double df)
	gets double value More...
double	getDoubleValue (const char *name, const double df)
	gets double value More...
SettingParameterValues *	getSubParameterValues (const char *key, const char *val=NULL)
	gets sub parameter values More...
bool	hasSubParameterValues (const char *key, const char *val=NULL)
	check the specified parameter has sub parameters More...

Static Public Member Functions
static void	writeAllChildParameters (kome::objects::SettingParameterValues &settings, kome::core::Properties &props, const char *prefix)
	write all child parameters More...

Protected Member Functions
int	getIndex (const char *name)
	gets parameter index from name More...

Protected Attributes
std::vector< std::pair < std::string, std::string > >	m_values
std::vector< std::pair < SubSettingsKey, SettingParameterValues * > >	m_itemValues

Detailed Description

setting parameter values management class

Definition at line 33 of file SettingParameterValues.h.

Constructor & Destructor Documentation

kome::objects::SettingParameterValues::SettingParameterValues

(

const SettingParameterValues &

other

)

copy constructor

Parameters

[in]

other

other settings object

Definition at line 32 of file SettingParameterValues.cpp.

                                                                                    {
    // copy values
    unsigned int valNum = other.m_values.size();
    if( valNum > 0 ) {
        m_values.reserve( valNum );

        for( unsigned int i = 0; i < valNum; i++ ) {
            m_values.push_back( other.m_values[ i ] );
        }
    }

    // copy subitems
    unsigned int itmNum = other.m_itemValues.size();
    if( itmNum > 0 ) {
        m_itemValues.reserve( itmNum );

        for( unsigned int i = 0; i < itmNum; i++ ) {
            m_itemValues.push_back(
                std::make_pair( other.m_itemValues[ i ].first, new SettingParameterValues( *( other.m_itemValues[ i ].second ) ))
            );
        }
    }
}

Member Function Documentation

bool kome::objects::SettingParameterValues::getBoolValue	(	const unsigned int	index,
		const bool	df
	)

gets boolean value

Parameters

[in]	index	parameter index
[in]	df	default value

Returns

boolean value

Definition at line 188 of file SettingParameterValues.cpp.

                                                                                   {
    // value
    const char* value = getParameterValue( index );
    const bool ret = tobool( value, df );

    return ret;
}

Here is the call graph for this function:

bool kome::objects::SettingParameterValues::getBoolValue	(	const char *	name,
		const bool	df
	)

gets boolean value

Parameters

[in]	name	parameter name
[in]	df	default value

Returns

boolean value

Definition at line 197 of file SettingParameterValues.cpp.

                                                                           {
    // value
    const char* value = getParameterValue( name );
    const bool ret = tobool( value, df );

    return ret;
}

Here is the call graph for this function:

double kome::objects::SettingParameterValues::getDoubleValue	(	const unsigned int	index,
		const double	df
	)

gets double value

Parameters

[in]	index	parameter index
[in]	df	default value

Returns

double value

Definition at line 224 of file SettingParameterValues.cpp.

                                                                                         {
    // value
    const char* value = getParameterValue( index );
    const double ret = todouble( value, df );

    return ret;
}

Here is the call graph for this function:

double kome::objects::SettingParameterValues::getDoubleValue	(	const char *	name,
		const double	df
	)

gets double value

Parameters

[in]	name	parameter name
[in]	df	default value

Returns

double value

Definition at line 233 of file SettingParameterValues.cpp.

                                                                                 {
    // value
    const char* value = getParameterValue( name );
    const double ret = todouble( value, df );

    return ret;
}

Here is the call graph for this function:

int kome::objects::SettingParameterValues::getIndex ( const char *  name )

protected

gets parameter index from name

Parameters

[in]

name

parameter name

Returns

parameter index (If negative value, specified parameter name was not found.)

Definition at line 102 of file SettingParameterValues.cpp.

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

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

    return idx;
}

int kome::objects::SettingParameterValues::getIntValue	(	const unsigned int	index,
		const int	df
	)

gets integer value

Parameters

[in]	index	parameter index
[in]	df	default value

Returns

integer value

Definition at line 206 of file SettingParameterValues.cpp.

                                                                                {
    // value
    const char* value = getParameterValue( index );
    const int ret = toint( value, 10, df );

    return ret;
}

Here is the call graph for this function:

int kome::objects::SettingParameterValues::getIntValue	(	const char *	name,
		const int	df
	)

gets integer value

Parameters

[in]	name	parameter name
[in]	df	default value

Returns

integer value

Definition at line 215 of file SettingParameterValues.cpp.

                                                                        {
    // value
    const char* value = getParameterValue( name );
    const int ret = toint( value, 10, df );

    return ret;
}

Here is the call graph for this function:

unsigned int kome::objects::SettingParameterValues::getNumberOfParameters

(

)

gets the number of parameters

Returns

the number of parameters

Definition at line 155 of file SettingParameterValues.cpp.

                                                           {
    return m_values.size();
}

const char * kome::objects::SettingParameterValues::getParameterName

(

const unsigned int

index

)

gets parameter name

Parameters

[in]

index

parameter index

Returns

parameter name

Definition at line 160 of file SettingParameterValues.cpp.

                                                                               {
    if( index >= m_values.size() ) {
        return NULL;
    }
    return m_values[ index ].first.c_str();
}

const char * kome::objects::SettingParameterValues::getParameterValue

(

const unsigned int

index

)

gets parameter value

Parameters

[in]

index

parameter index

Returns

parameter value

Definition at line 168 of file SettingParameterValues.cpp.

                                                                                {
    if( index >= m_values.size() ) {
        return NULL;
    }
    return m_values[ index ].second.c_str();          //�ŏI�I�ɂ͂��ꂪgetParameterValue( name )����Ԃ�
}

const char * kome::objects::SettingParameterValues::getParameterValue

(

const char *

name

)

gets parameter value

Parameters

[in]

name

parameter name

Returns

parameter value (If NULL, there is no parameter that has specified name.)

Definition at line 176 of file SettingParameterValues.cpp.

                                                                        {
    // index
    int idx = getIndex( name );
    if( idx < 0 ) {
        return NULL;
    }

    // value
    return getParameterValue( idx );
}

Here is the call graph for this function:

SettingParameterValues * kome::objects::SettingParameterValues::getSubParameterValues	(	const char *	key,
		const char *	val = NULL
	)

gets sub parameter values

Parameters

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

Returns

sub parameter values

Definition at line 242 of file SettingParameterValues.cpp.

                                                                                                        {
    // parameters
    if( val == NULL ) {
        val = getParameterValue( key );
    }

    // key, value
    std::string k = NVL( key, "" );
    if( val == NULL ) {
        val = getParameterValue( key );
    }
    std::string v = NVL( val, "" );

    // search
    int itemIdx = -1;
    for( unsigned int i = 0; i < m_itemValues.size() && itemIdx < 0; i++ ) {
        if( k.compare( m_itemValues[ i ].first.key ) == 0
                && v.compare( m_itemValues[ i ].first.value ) == 0 ) {
            itemIdx = (int)i;
        }
    }

    // create new sub settings
    if( itemIdx < 0 ) {
        itemIdx = (int)m_itemValues.size();
        SettingParameterValues* subVals = new SettingParameterValues();

        m_itemValues.resize( m_itemValues.size() + 1 );

        m_itemValues.back().first.key = k;
        m_itemValues.back().first.value = v;
        m_itemValues.back().second = subVals;
    }

    return m_itemValues[ itemIdx ].second;
}

Here is the call graph for this function:

bool kome::objects::SettingParameterValues::hasSubParameterValues	(	const char *	key,
		const char *	val = NULL
	)

check the specified parameter has sub parameters

Parameters

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

Returns

If true, the specified parameter has sub parameters

Definition at line 280 of file SettingParameterValues.cpp.

                                                                                     {
    // parameters
    if( val == NULL ) {
        val = getParameterValue( key );
    }

    // key, value
    std::string k = NVL( key, "" );
    if( val == NULL ) {
        val = getParameterValue( key );
    }
    std::string v = NVL( val, "" );

    // search
    int itemIdx = -1;
    for( unsigned int i = 0; i < m_itemValues.size() && itemIdx < 0; i++ ) {
        if( k.compare( m_itemValues[ i ].first.key ) == 0
                && v.compare( m_itemValues[ i ].first.value ) == 0 ) {
            itemIdx = (int)i;
        }
    }

    return ( itemIdx >= 0 );
}

Here is the call graph for this function:

SettingParameterValues & kome::objects::SettingParameterValues::operator=

(

const SettingParameterValues &

other

)

the definition of assignment operator

Parameters

[in]

other

other settings object

Returns

assigned settings object

Definition at line 57 of file SettingParameterValues.cpp.

                                                                                               {
    // copy values
    unsigned int valNum = other.m_values.size();
    if( valNum > 0 ) {
        m_values.reserve( valNum );

        for( unsigned int i = 0; i < valNum; i++ ) {
            m_values.push_back( other.m_values[ i ] );
        }
    }

    // copy subitems
    unsigned int itmNum = other.m_itemValues.size();
    if( itmNum > 0 ) {
        m_itemValues.reserve( itmNum );

        for( unsigned int i = 0; i < itmNum; i++ ) {
            m_itemValues.push_back(
                std::make_pair(
                    other.m_itemValues[ i ].first,
                    new SettingParameterValues( *( other.m_itemValues[ i ].second ) )
                )
            );
        }
    }

    return *this;
}

void kome::objects::SettingParameterValues::setValue	(	const unsigned int	index,
		const char *	value
	)

sets parameter value

Parameters

[in]	index	parameter index
[in]	value	parameter value

Definition at line 118 of file SettingParameterValues.cpp.

                                                                                   {
    // check the index
    if( index >= m_values.size() ) {
        return;
    }

    // value
    std::string v = NVL( value, "" );
    if( v.compare( MSPP_SETTINGS_NONE_VALUE ) == 0 ) {
        v = "";
    }

    // set value
    m_values[ index ].second = v;
}

void kome::objects::SettingParameterValues::setValue	(	const char *	name,
		const char *	value
	)

sets parameter value

Parameters

[in]	name	parameter name
[in]	value	parameter value

Definition at line 135 of file SettingParameterValues.cpp.

                                                                           {
    // index
    int idx = getIndex( name );

    // value
    std::string v = NVL( value, "" );
    if( v.compare( MSPP_SETTINGS_NONE_VALUE ) == 0 ) {
        v = "";
    }

    // set value
    if( idx < 0 ) {
        m_values.push_back( std::make_pair ( NVL( name, "" ), v ) );
    }
    else {
        setValue( idx, v.c_str() );
    }
}

Here is the call graph for this function:

static void kome::objects::SettingParameterValues::writeAllChildParameters ( kome::objects::SettingParameterValues &  settings, kome::core::Properties &  props, const char *  prefix  )

static

write all child parameters

Parameters

[in]	settings	parameters
[out]	props	property objects to be stored.
[in]	prefix	prefix string

Definition at line 306 of file SettingParameterValues.cpp.

  {
    // prefix
    std::string p = NVL( prefix, "" );

    // write
    for( unsigned int i = 0; i < settings.getNumberOfParameters(); i++ ) {
        std::string name = settings.getParameterName( i );
        std::string value = settings.getParameterValue( i );
        std::string propName = name;
        if( !p.empty() ) {
            propName = FMT( "%s : %s", p.c_str(), name.c_str() );
        }

        props.setValue( propName.c_str(), value.c_str() );

        // child
        if( settings.hasSubParameterValues( name.c_str(), value.c_str() ) ) {
            kome::objects::SettingParameterValues* child = settings.getSubParameterValues( name.c_str(), value.c_str() );
            writeAllChildParameters( *child, props, propName.c_str() );
        }
    }
}

Here is the call graph for this function:

Member Data Documentation

std::vector< std::pair< SubSettingsKey, SettingParameterValues* > > kome::objects::SettingParameterValues::m_itemValues

protected

item values

Definition at line 68 of file SettingParameterValues.h.

std::vector< std::pair< std::string, std::string > > kome::objects::SettingParameterValues::m_values

protected

values

Definition at line 65 of file SettingParameterValues.h.

---

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

• DataObjects/SettingParameterValues.h
• DataObjects/SettingParameterValues.cpp