alignment class More...

#include <BatchAnalysis.h>

Public Member Functions
	BatchAnalysis (const char *analysisName)
	constructor More...

virtual	~BatchAnalysis ()
	destructor

void	clearFileProperties ()
	clears file propertyes

int	addFileProperty (const char *prop)
	adds file property More...

unsigned int	getNumberOfFileProperties ()
	gets the number of file properties More...

const char *	getFileProperty (const unsigned int idx)
	gets the file property More...

kome::plugin::SettingsPage *	getFilesPage ()
	gets the files page More...

void	getFiles (kome::objects::SettingParameterValues *settings, std::vector< std::pair< std::string, kome::core::Properties > > &files)
	gets files More...

kome::plugin::SettingsPage *	getParametersPage ()
	gets the parameters page More...

void	analyze (std::vector< std::string > &paths, kome::core::Progress &progress)
	analyzes More...

void	showResult ()
	shows analysis result

Protected Member Functions
virtual void	onCreateFilesPage (kome::plugin::ParameterSettings &params, kome::plugin::SettingsPage &page)
	creates files page More...

virtual void	onGetFiles (kome::objects::SettingParameterValues *settings, std::vector< std::pair< std::string, kome::core::Properties > > &files)
	This method is called form the getFiles method. More...

virtual void	onCreateParametersPage (kome::plugin::ParameterSettings &params, kome::plugin::SettingsPage &page)
	creates parameters More...

virtual void	onPrepareAnalysis (std::vector< std::string > &paths, kome::core::Progress &progress)=0
	on prepares analysis More...

virtual void	onAnalyze (const char *path, kome::core::Progress &progress)=0
	on analyze More...

virtual void	onFinishAnalysis (kome::core::Progress &progress)=0
	on finish analysis More...

virtual void	onShowResult ()=0
	shows analysis result

Static Protected Member Functions
static void	getFiles (const char *dir, std::vector< std::pair< std::string, kome::core::Properties > > &files)
	gets files More...

Protected Attributes
std::string	m_name

std::vector< std::string >	m_fileProperties

kome::plugin::ParameterSettings	m_params

kome::plugin::SettingsPage *	m_filesPage

kome::plugin::SettingsPage *	m_parametersPage

Static Protected Attributes
static const char *	FILE_NAME_PROP_NAME = "File Name"

static const char *	DIR_PARAM_NAME = "dir"

Detailed Description

alignment class

Definition at line 24 of file BatchAnalysis.h.

Constructor & Destructor Documentation

kome::operation::BatchAnalysis::BatchAnalysis ( const char * analysisName )

constructor

Parameters

[in] analysisName analysis name

Definition at line 36 of file BatchAnalysis.cpp.

                                                        : m_params( NULL, false ) {
     // initialize
     m_name = NVL( analysisName, "" );
     m_filesPage = NULL;
     m_parametersPage = NULL;
 
     // add file name property
     addFileProperty( FILE_NAME_PROP_NAME );
 }

Here is the call graph for this function:

Member Function Documentation

int kome::operation::BatchAnalysis::addFileProperty ( const char * prop )

adds file property

Parameters

[in] prop file property

Returns: file property index

Definition at line 56 of file BatchAnalysis.cpp.

                                                      {
     int idx = (int)m_fileProperties.size();
     m_fileProperties.push_back( NVL( prop, "" ) );
     return idx;
 }

void kome::operation::BatchAnalysis::analyze	(	std::vector< std::string > &	paths,
		kome::core::Progress &	Progress
	)

analyzes

Parameters

[in]	paths	file paths
[out]	progress	the object to show progress

Definition at line 135 of file BatchAnalysis.cpp.

                                                                                        {
     // subprogresses
     progress.createSubProgresses( paths.size() + 2 );
 
     // preparation
     int progressIdx = 0;
     kome::core::Progress* subProgress = progress.getSubProgress( progressIdx );
     progressIdx++;
     progress.setStatus( "Preparation..." );
     onPrepareAnalysis( paths, *subProgress );
     if( progress.isStopped() ) {
         return;
     }
     subProgress->fill();
 
     // analyze each file
     for( unsigned int i = 0; i < paths.size() && !progress.isStopped(); i++ ) {    // each file
         // progress
         std::string message = FMT( "Analyzing ... [%d/%d]", ( i + 1 ), paths.size() );
         progress.setStatus( message.c_str() );
         subProgress = progress.getSubProgress( progressIdx );
         progressIdx++;
 
         // analyze
         onAnalyze( paths[ i ].c_str(), *subProgress );
         subProgress->fill();
     }
     if( progress.isStopped() ) {
         return;
     }
 
     // post analysis
     subProgress = progress.getSubProgress( progressIdx );
     progress.setStatus( "Finalizing..." );
     onFinishAnalysis( *subProgress );
 
     if( !progress.isStopped() ) {
         progress.fill();
     }
 }

Here is the call graph for this function:

const char * kome::operation::BatchAnalysis::getFileProperty ( const unsigned int idx )

gets the file property

Parameters

[in] property index

Returns: file property

Definition at line 68 of file BatchAnalysis.cpp.

                                                              {
     if( idx < 0 || idx >= (int)m_fileProperties.size() ) {
         return NULL;
     }
     return m_fileProperties[ idx ].c_str();
 }

void kome::operation::BatchAnalysis::getFiles	(	kome::objects::SettingParameterValues *	settings,
		std::vector< std::pair< std::string, kome::core::Properties > > &	files
	)

gets files

Parameters

[in]	settings	parameters
[out]	paths	the array to store file paths.

Definition at line 87 of file BatchAnalysis.cpp.

                                                                                                                                         {
     onGetFiles( settings, files );
 }

Here is the call graph for this function:

static void kome::operation::BatchAnalysis::getFiles	(	const char *	dir,
		std::vector< std::pair< std::string, kome::core::Properties > > &	files
	)

staticprotected

gets files

Parameters

[in]	dir	directory
[out]	files	the array to store file informations

Definition at line 187 of file BatchAnalysis.cpp.

                                                                                                             {
     // path
     boost::filesystem::path p( dir, boost::filesystem::native );
 
     // store
     if( boost::filesystem::is_directory( p ) ) {    // directory
         boost::filesystem::directory_iterator end;
         for( boost::filesystem::directory_iterator it( p ); it != end; it++ ) {    // each child
             boost::filesystem::path child = (*it);
             getFiles( boost::filesystem::absolute( child ).string().c_str(), files );
         }
     }
     else {    // file
         files.resize( files.size() + 1 );
         files.back().first = boost::filesystem::absolute( p ).string();
         files.back().second.setValue( FILE_NAME_PROP_NAME, p.leaf().string().c_str() );
     }
 }

Here is the call graph for this function:

kome::plugin::SettingsPage * kome::operation::BatchAnalysis::getFilesPage ( )

gets the files page

Returns: files page

Definition at line 76 of file BatchAnalysis.cpp.

                                                     {
     // create page
     if( m_filesPage == NULL ) {
         m_filesPage = new kome::plugin::SettingsPage( m_params );
         onCreateFilesPage( m_params, *m_filesPage );
     }
 
     return m_filesPage;
 }

Here is the call graph for this function:

unsigned int kome::operation::BatchAnalysis::getNumberOfFileProperties ( )

gets the number of file properties

Returns: the number of file properties

Definition at line 63 of file BatchAnalysis.cpp.

                                                       {
     return m_fileProperties.size();
 }

kome::plugin::SettingsPage * kome::operation::BatchAnalysis::getParametersPage ( )

gets the parameters page

Returns: parameters page

Definition at line 92 of file BatchAnalysis.cpp.

                                                          {
     // create page
     if( m_parametersPage == NULL ) {
         m_parametersPage = new kome::plugin::SettingsPage( m_params );
         onCreateParametersPage( m_params, *m_parametersPage );
     }
 
     return m_parametersPage;
 }

Here is the call graph for this function:

void kome::operation::BatchAnalysis::onAnalyze	(	const char *	path,
		kome::core::Progress &	progress
	)

protectedpure virtual

on analyze

Parameters

[in]	path	file path
[out]	progress	the object to show the progress

void kome::operation::BatchAnalysis::onCreateFilesPage	(	kome::plugin::ParameterSettings &	params,
		kome::plugin::SettingsPage &	page
	)

protectedvirtual

creates files page

Parameters

[out]	params	parameters information
[out]	page	page

Definition at line 103 of file BatchAnalysis.cpp.

                                                                                                          {
     // value
     kome::plugin::SettingsValue* value = params.addValue();
     value->setType( kome::plugin::SettingsValue::TYPE_DIR );
     value->setRequired( true );
 
     // parameter
     kome::plugin::SettingsParam* param = params.addParam();
     param->setSection( FMT( "Batch Analysis (%s)", m_name.c_str() ).c_str() );
     param->setKey( "DIR" );
     param->setName( DIR_PARAM_NAME );
 
     // form
     kome::plugin::SettingsForm* form = page.addForm();
     form->setTitle( "Directory" );
     form->setParam( param );
     form->setDesc( "Select the data folder." );
 }

void kome::operation::BatchAnalysis::onCreateParametersPage	(	kome::plugin::ParameterSettings &	params,
		kome::plugin::SettingsPage &	page
	)

protectedvirtual

creates parameters

Parameters

[out]	params	parameters information
[out]	page	page

Definition at line 182 of file BatchAnalysis.cpp.

                                                                                                               {
     LOG_WARN( FMT( "This method is underconstruction. Please implement onCreateParametersPage method in the subclass of BatchAnalysis." ) );
 }

void kome::operation::BatchAnalysis::onFinishAnalysis ( kome::core::Progress & progress )

protectedpure virtual

on finish analysis

Parameters

[out] progress the object to show the progress

void kome::operation::BatchAnalysis::onGetFiles	(	kome::objects::SettingParameterValues *	settings,
		std::vector< std::pair< std::string, kome::core::Properties > > &	files
	)

protectedvirtual

This method is called form the getFiles method.

Parameters

[in]	settings	parameters
[out]	files	the array to store file informations

Definition at line 123 of file BatchAnalysis.cpp.

                                                                                                                                           {
     // directory
     std::string dir = settings->getParameterValue( DIR_PARAM_NAME );
     if( dir.empty() ) {
         return;
     }
 
     // get files
     getFiles( dir.c_str(), files );
 }

Here is the call graph for this function:

void kome::operation::BatchAnalysis::onPrepareAnalysis	(	std::vector< std::string > &	paths,
		kome::core::Progress &	progress
	)

protectedpure virtual

on prepares analysis

Parameters

[in]	paths	analysis files
[out]	progress	the object to show the progress

Member Data Documentation

const char * BatchAnalysis::DIR_PARAM_NAME = "dir"

staticprotected

directory parameter name

Definition at line 60 of file BatchAnalysis.h.

const char * BatchAnalysis::FILE_NAME_PROP_NAME = "File Name"

staticprotected

file name property name

Definition at line 57 of file BatchAnalysis.h.

std::vector< std::string > kome::operation::BatchAnalysis::m_fileProperties

protected

file properties

Definition at line 44 of file BatchAnalysis.h.

kome::plugin::SettingsPage* kome::operation::BatchAnalysis::m_filesPage

protected

files page

Definition at line 50 of file BatchAnalysis.h.

std::string kome::operation::BatchAnalysis::m_name

protected

name

Definition at line 41 of file BatchAnalysis.h.

kome::plugin::SettingsPage* kome::operation::BatchAnalysis::m_parametersPage

protected

parameter page

Definition at line 53 of file BatchAnalysis.h.

kome::plugin::ParameterSettings kome::operation::BatchAnalysis::m_params

protected

parameters

Definition at line 47 of file BatchAnalysis.h.

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

DataOperation/BatchAnalysis.h
DataOperation/BatchAnalysis.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation