kome::objects::Script Class Reference

script abstract class More...

#include <Script.h>

Collaboration diagram for kome::objects::Script:

Classes
struct	VariableInfo
	variable information More...

Public Member Functions
	Script ()
	constructor
virtual	~Script ()
	destructor
void	setScript (const char *script)
	sets the script More...
const char *	getScript ()
	gets the script More...
void	setVariant (kome::objects::Variant &var)
	sets the variant(Active Object) More...
const kome::objects::Variant &	getVariant (void)
	gets the variant More...
void	setParameters (kome::objects::Parameters *pParams)
	sets the variant(Active Object) More...
const kome::objects::Parameters *	getParameters (void)
	gets the parameter More...
std::string	getTemplate ()
	gets the template More...
std::string	run (const char *script, kome::objects::Variant &var, kome::objects::Parameters *pParams)
	run the script More...
std::string	run ()
	run the script More...
void	clearVariables ()
	clears variables
void	addVariable (const char *name, const char *desc)
	adds variable
unsigned int	getNumberOfVariables ()
	gets the number of variables More...
const char *	getVariableName (const unsigned int idx)
	gets the variable name More...
const char *	getVariableDescription (const unsigned int idx)
	gets the variable description More...

Static Public Member Functions
static void	setScriptFilePath (const char *path)
	sets the script file path More...
static const char *	getScriptFilePath ()
	gets the script file path More...

Protected Member Functions
virtual std::string	onRun (const char *script, kome::objects::Variant &var, kome::objects::Parameters *pParams)=0
	This method is called from the run method. (abstract method) More...
virtual std::string	onGetTemplate ()=0
	This method is called from the getTempalte method. (abstract method) More...

Protected Attributes
std::string	m_script
std::vector< VariableInfo >	m_variables
kome::objects::Variant	m_refVariant
kome::objects::Parameters *	m_pParams

Static Protected Attributes
static std::string	m_filePath

Detailed Description

script abstract class

Definition at line 39 of file Script.h.

Member Function Documentation

unsigned int kome::objects::Script::getNumberOfVariables

(

)

gets the number of variables

Returns

the number of variables

Definition at line 156 of file Script.cpp.

                                          {
    return m_variables.size();
}

const kome::objects::Parameters * kome::objects::Script::getParameters

(

void

)

gets the parameter

Returns

pointer of parameter

Definition at line 93 of file Script.cpp.

{
    return  m_pParams;
}

const char * kome::objects::Script::getScript

(

)

gets the script

Returns

character string of the script

Definition at line 62 of file Script.cpp.

                              {
    return m_script.c_str();
}

static const char * kome::objects::Script::getScriptFilePath ( )

static

gets the script file path

Returns

script file path

Definition at line 184 of file Script.cpp.

                                      {
    return m_filePath.c_str();
}

std::string kome::objects::Script::getTemplate

(

)

gets the template

Returns

template

Definition at line 67 of file Script.cpp.

                              {
    std::string t = onGetTemplate();

    return t;
}

Here is the call graph for this function:

const char * kome::objects::Script::getVariableDescription

(

const unsigned int

idx

)

gets the variable description

Parameters

[in]

idx

variable index

Returns

variable description

Definition at line 170 of file Script.cpp.

                                                                   {
    if( idx >= m_variables.size() ) {
        return NULL;
    }

    return m_variables[ idx ].desc.c_str();
}

const char * kome::objects::Script::getVariableName

(

const unsigned int

idx

)

gets the variable name

Parameters

[in]

idx

variable index

Returns

variable name

Definition at line 161 of file Script.cpp.

                                                            {
    if( idx >= m_variables.size() ) {
        return NULL;
    }

    return m_variables[ idx ].name.c_str();
}

const kome::objects::Variant & kome::objects::Script::getVariant

(

void

)

gets the variant

Returns

refer of ActiveObject what is provided by the Variant type

Definition at line 81 of file Script.cpp.

{
    return  m_refVariant;
}

std::string kome::objects::Script::onGetTemplate ( )

protectedpure virtual

This method is called from the getTempalte method. (abstract method)

Returns

template

std::string kome::objects::Script::onRun ( const char *  script, kome::objects::Variant &  var, kome::objects::Parameters *  pParams  )

protectedpure virtual

This method is called from the run method. (abstract method)

Parameters

[in]	script	character string of the script
[in]	var	ActiveObject what is provided by the Variant type
[in]	pParams	pointer of parameter

Returns

result string

std::string kome::objects::Script::run	(	const char *	script,
		kome::objects::Variant &	var,
		kome::objects::Parameters *	pParams
	)

run the script

Parameters

[in]	script	character string of the script
[in]	var	ActiveObject what is provided by the Variant type
[in]	pParams	pointer of parameter

Returns

result string

Definition at line 102 of file Script.cpp.

                                                                                                   {
    setScript( script );
// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
    setVariant( var );
    setParameters( pParams );
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

    std::string ret = run();

    return ret;
}

Here is the call graph for this function:

std::string kome::objects::Script::run

(

)

run the script

Returns

result string

Definition at line 115 of file Script.cpp.

                      {
// >>>>>>   @Date:2013/07/29    <Add>   A.Ozaki
    std::string ret = onRun( m_script.c_str( ), m_refVariant, m_pParams );
// <<<<<<   @Date:2013/07/29    <Add>   A.Ozaki

    return ret;
}

Here is the call graph for this function:

void kome::objects::Script::setParameters

(

kome::objects::Parameters *

pParams

)

sets the variant(Active Object)

Parameters

[in]

pParams

pointer of parameter

Definition at line 87 of file Script.cpp.

{
    m_pParams = pParams;
}

void kome::objects::Script::setScript

(

const char *

script

)

sets the script

Parameters

[in]

script

character string of the script

Definition at line 57 of file Script.cpp.

                                           {
    m_script = NVL( script, "" );
}

static void kome::objects::Script::setScriptFilePath ( const char *  path )

static

sets the script file path

Parameters

[in]

path

script file path

Definition at line 179 of file Script.cpp.

                                                 {
    m_filePath = NVL( path, "" );
}

void kome::objects::Script::setVariant

(

kome::objects::Variant &

var

)

sets the variant(Active Object)

Parameters

[in]

var

ActiveObject what is provided by the Variant type

Definition at line 75 of file Script.cpp.

{
    m_refVariant = var;
}

Member Data Documentation

std::string Script::m_filePath

staticprotected

script file path

Definition at line 70 of file Script.h.

kome::objects::Parameters* kome::objects::Script::m_pParams

protected

parameter

Definition at line 77 of file Script.h.

kome::objects::Variant kome::objects::Script::m_refVariant

protected

Active Object

Definition at line 74 of file Script.h.

std::string kome::objects::Script::m_script

protected

script

Definition at line 55 of file Script.h.

std::vector< VariableInfo > kome::objects::Script::m_variables

protected

variables

Definition at line 67 of file Script.h.

---

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

• DataObjects/Script.h
• DataObjects/Script.cpp