kome::objects::Parameters Class Reference

parameters of plug-in function management class More...

#include <Parameters.h>

Public Member Functions
	Parameters ()
	constructor
virtual	~Parameters ()
	destructor
unsigned int	getNumberOfParameters ()
	gets the number of parameters More...
const char *	getName (unsigned int index)
	gets parameter name More...
Variant &	getValue (const char *name)
	gets parameter value More...
bool	hasParameter (const char *name)
	gets wheter there is parameter with the specified name. More...

Protected Attributes
std::vector< std::string >	m_parameters
std::map< std::string, Variant >	m_parameterMap

Detailed Description

parameters of plug-in function management class

Definition at line 28 of file Parameters.h.

Member Function Documentation

const char * kome::objects::Parameters::getName

(

unsigned int

index

)

gets parameter name

Parameters

[in]

index

parameter index

Returns

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

Definition at line 38 of file Parameters.cpp.

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

    return m_parameters[index].c_str();
}

unsigned int kome::objects::Parameters::getNumberOfParameters

(

)

gets the number of parameters

Returns

the number of parameters

Definition at line 33 of file Parameters.cpp.

                                               {
    return m_parameters.size();
}

Variant * kome::objects::Parameters::getValue

(

const char *

name

)

gets parameter value

Parameters

[in]

name

parameter name

Returns

parameter value.

Definition at line 48 of file Parameters.cpp.

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

    // check the map
    if( m_parameterMap.find( s ) == m_parameterMap.end() ) {    // new parameter
        m_parameters.push_back( s );
    }

    // return value
    return m_parameterMap[ s ];
}

bool kome::objects::Parameters::hasParameter

(

const char *

name

)

gets wheter there is parameter with the specified name.

Returns

If there is the parameter with the specified name, this method returns true.

Definition at line 62 of file Parameters.cpp.

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

    // check the map
    return ( m_parameterMap.find( s ) != m_parameterMap.end() );
}

Member Data Documentation

std::map< std::string, Variant > kome::objects::Parameters::m_parameterMap

protected

the map of parameter value (parameter name -> parameter value)

Definition at line 77 of file Parameters.h.

std::vector< std::string > kome::objects::Parameters::m_parameters

protected

the array of parameter name

Definition at line 74 of file Parameters.h.

---

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

• DataObjects/Parameters.h
• DataObjects/Parameters.cpp