#include <Operation.h>

Collaboration diagram for kome::operation::Operation:

Public Types
enum	OperationType { TYPE_STANDARD = 0, TYPE_GUI = 1, TYPE_INPUT = 2, TYPE_OUTPUT = 4, TYPE_AUTO = 8 }
	operation type

Public Member Functions
	Operation ()
	constructor

virtual	~Operation ()
	destructor

void	setOperationName (const char *operationName)
	sets operation name More...

const char *	getOperationName ()
	gets operation name More...

void	setShortName (const char *shortName)
	sets short name More...

const char *	getShortName ()
	gets short name More...

void	setOperationType (int type)
	sets operation type More...

int	getOperationType ()
	gets operation type More...

void	setDescription (const char *description)
	sets description More...

const char *	getDescription ()
	gets description More...

void	setTargetSample (kome::objects::Sample *sample)
	sets target sample objects More...

kome::objects::Sample *	getTargetSample ()
	gets target sample objects More...

void	setParametersString (const char *parameter)
	sets parameters string More...

const char *	getParametersString ()
	gets operaton parameters string More...

void	loadCondition (boost::function< int(void *, int) > readFun)
	load the saved state with operations More...

void	saveCondition (boost::function< int(void *, int) > writeFun)
	save the current state with engine operations More...

bool	execute ()
	execute operation More...

std::string	getPrevFilePath ()
	gets previouse data file path More...

void	setPrevFilePath (const char *strPath)
	sets previouse data file path More...

std::string	getUpdateFilePath ()
	gets udate data file path More...

void	setUpdateFilePath (const char *strPath)
	sets udate data file path More...

void	removeOperation (Operation *opt)
	remove operation More...

Protected Member Functions
virtual std::string	onGetDescription ()=0
	get discription More...

virtual std::string	onGetParametersString ()=0
	get parameters string More...

virtual void	onSetParametersString (const char *strParam)=0
	set parameters string More...

virtual void	onLoadCondition (boost::function< int(void *, int) > readFun)=0
	load the saved state with respect to to search engine operations More...

virtual void	onSaveCondition (boost::function< int(void *, int) > writeFun)=0
	save the current state with respect to search engine operations More...

virtual bool	onExecute ()=0
	execute operation More...

Protected Attributes
std::string	m_operatName

std::string	m_shortName

int	m_type

std::string	m_descript

kome::objects::Sample *	m_targetSample

std::string	m_paramString

std::string	m_prevPath

std::string	m_updatePath

Detailed Description

Operation information class.

Definition at line 22 of file Operation.h.

Member Function Documentation

bool kome::operation::Operation::execute ( )

execute operation

Returns: If true, it succeeded to perform search.

Definition at line 126 of file Operation.cpp.

                        {
     bool ret = false;
 
     OperationManager& optMgr = OperationManager::getInstance();
     if( getOperationType() == Operation::TYPE_INPUT ||
         getOperationType() == Operation::TYPE_OUTPUT ){
 
         // execute
         ret = onExecute();
     }else{
         // -----
         // Undo
         // -----
         m_prevPath = optMgr.getPreviousDataFilePath( this );    
         FILE* prevfp = fileopen( m_prevPath.c_str(), "wb" );
 
         kome::core::FileAccessor prev_acc( prevfp );
         saveCondition( boost::bind( &kome::core::DataAccessor::write, &prev_acc, _1, _2 ) );
         
         fclose( prevfp );               
         
         // Previous Data File Path 
         setPrevFilePath( m_prevPath.c_str() );
 
         // execute
         ret = onExecute();
 
         // -----
         // Redo
         // -----
         m_updatePath = optMgr.getUpdateDataFilePath( this );
         FILE* updatefp = fileopen( m_updatePath.c_str(), "wb" );
 
         kome::core::FileAccessor update_acc( updatefp );
         saveCondition( boost::bind( &kome::core::DataAccessor::write, &update_acc, _1, _2 ) );
 
         fclose( updatefp );
 
         // Update Data File Path
         setUpdateFilePath( m_updatePath.c_str() );
     }
     if( ret ){
         // Finished
         optMgr.moveToFinished( this );
     }
     return ret;
 }

Here is the call graph for this function:

const char * kome::operation::Operation::getDescription ( )

gets description

Returns: operaton description

Definition at line 83 of file Operation.cpp.

                                      {
     if( m_descript.empty() ){   // @date 2013.09.17 <Mod> M.Izumi
         m_descript = onGetDescription();
     }
     return m_descript.c_str();  
 }

Here is the call graph for this function:

const char * kome::operation::Operation::getOperationName ( )

gets operation name

Returns: operation name

Definition at line 53 of file Operation.cpp.

                                        {
     return m_operatName.c_str();
 }

int kome::operation::Operation::getOperationType ( )

gets operation type

Returns: operaton type

Definition at line 73 of file Operation.cpp.

                                {
     return m_type;
 }

const char * kome::operation::Operation::getParametersString ( )

gets operaton parameters string

Returns: operaton parameters string

Definition at line 106 of file Operation.cpp.

                                           {
     m_paramString = "";
     m_paramString = "\"";   
     m_paramString += onGetParametersString().c_str();
     m_paramString +="\"";
 
     return m_paramString.c_str();
 }

Here is the call graph for this function:

std::string kome::operation::Operation::getPrevFilePath ( )

gets previouse data file path

Returns: previouse data file path

Definition at line 175 of file Operation.cpp.

                                     {
     return m_prevPath;
 }

const char * kome::operation::Operation::getShortName ( )

gets short name

Returns: short name

Definition at line 63 of file Operation.cpp.

                                    {
     return m_shortName.c_str();
 }

kome::objects::Sample * kome::operation::Operation::getTargetSample ( )

gets target sample objects

Returns: target sample objects

Definition at line 96 of file Operation.cpp.

                                              {
     return m_targetSample;
 }

std::string kome::operation::Operation::getUpdateFilePath ( )

gets udate data file path

Returns: udate data file path

Definition at line 185 of file Operation.cpp.

                                       {
     return m_updatePath;
 }

void kome::operation::Operation::loadCondition ( boost::function< int(void *, int) > readFun )

load the saved state with operations

Parameters

[in] readFun function to read saved state

Definition at line 116 of file Operation.cpp.

                                                                          {
     onLoadCondition( readFun );
 }

Here is the call graph for this function:

bool kome::operation::Operation::onExecute ( )

protectedpure virtual

execute operation

Returns: If true, it succeeded to perform search.

std::string kome::operation::Operation::onGetDescription ( )

protectedpure virtual

get discription

Returns: discription

std::string kome::operation::Operation::onGetParametersString ( )

protectedpure virtual

get parameters string

Returns: parameters string

void kome::operation::Operation::onLoadCondition ( boost::function< int(void *, int) > readFun )

protectedpure virtual

load the saved state with respect to to search engine operations

Parameters

[in] readFun function to read saved state

void kome::operation::Operation::onSaveCondition ( boost::function< int(void *, int) > writeFun )

protectedpure virtual

save the current state with respect to search engine operations

Parameters

[in] writeFun function to save state

void kome::operation::Operation::onSetParametersString ( const char * strParam )

protectedpure virtual

set parameters string

Parameters

[in] strParam parameters string

void kome::operation::Operation::removeOperation ( Operation * opt )

remove operation

Parameters

[in] opt delete operation

void kome::operation::Operation::saveCondition ( boost::function< int(void *, int) > writeFun )

save the current state with engine operations

Parameters

[in] writeFun function to save state

Definition at line 121 of file Operation.cpp.

                                                                            {
     onSaveCondition( writeFun );
 }

Here is the call graph for this function:

void kome::operation::Operation::setDescription ( const char * description )

sets description

Parameters

[in] description operaton description

Definition at line 78 of file Operation.cpp.

                                                        {
     m_descript = description;
 }

void kome::operation::Operation::setOperationName ( const char * operationName )

sets operation name

Parameters

[in] operationName operation name

Definition at line 48 of file Operation.cpp.

                                                            {
     m_operatName = operationName;
 }

void kome::operation::Operation::setOperationType ( int type )

sets operation type

Parameters

[in] type operaton type

Definition at line 68 of file Operation.cpp.

                                           {
     m_type = type;
 }

void kome::operation::Operation::setParametersString ( const char * parameter )

sets parameters string

Parameters

[in] parameter parameters string

Definition at line 101 of file Operation.cpp.

                                                           {
     onSetParametersString( parameter );
 }

Here is the call graph for this function:

void kome::operation::Operation::setPrevFilePath ( const char * strPath )

sets previouse data file path

Parameters

[in] strPath previouse data file path

Definition at line 180 of file Operation.cpp.

                                                     {
     m_prevPath = strPath;
 }

void kome::operation::Operation::setShortName ( const char * shortName )

sets short name

Parameters

[in] shortName short name

Definition at line 58 of file Operation.cpp.

                                                    {
     m_shortName = shortName;
 }

void kome::operation::Operation::setTargetSample ( kome::objects::Sample * sample )

sets target sample objects

Parameters

[in] sample target sample objects

Definition at line 91 of file Operation.cpp.

                                                           {
     m_targetSample = sample;
 }

void kome::operation::Operation::setUpdateFilePath ( const char * strPath )

sets udate data file path

Parameters

[in] strPath update data file path

Definition at line 190 of file Operation.cpp.

                                                       {
     m_updatePath = strPath;
 }

Member Data Documentation

std::string kome::operation::Operation::m_descript

protected

descript

Definition at line 47 of file Operation.h.

std::string kome::operation::Operation::m_operatName

protected

operation name

Definition at line 38 of file Operation.h.

std::string kome::operation::Operation::m_paramString

protected

parameter string

Definition at line 53 of file Operation.h.

std::string kome::operation::Operation::m_prevPath

protected

previouse data file path

Definition at line 56 of file Operation.h.

std::string kome::operation::Operation::m_shortName

protected

short name

Definition at line 41 of file Operation.h.

kome::objects::Sample* kome::operation::Operation::m_targetSample

protected

target sample

Definition at line 50 of file Operation.h.

int kome::operation::Operation::m_type

protected

operation type

Definition at line 44 of file Operation.h.

std::string kome::operation::Operation::m_updatePath

protected

update data file path

Definition at line 59 of file Operation.h.

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

DataOperation/Operation.h
DataOperation/Operation.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation