sample set information management class More...

#include <SampleSet.h>

Collaboration diagram for kome::objects::SampleSet:

Public Member Functions
	SampleSet ()
	constructor

virtual	~SampleSet ()
	destructor

int	getSampleSetId ()
	gets the sample set ID More...

void	setFilePath (const char *path)
	sets the file path More...

const char *	getFilePath ()
	gets file path More...

const char *	getFileName ()
	gets file name More...

bool	isOpened ()
	judges whther this sample set file is opened or not More...

int	getErrorCode (void)
	get error code of file access. More...

void	setErrorCode (const int errorCode)
	set error code of file access. More...

void	clearSamples ()
	clears samples

void	addSample (Sample *sample)
	adds sample More...

unsigned int	getNumberOfSamples ()
	gets the nubmer of samples More...

Sample *	getSample (const unsigned int index)
	gets sample object More...

bool	openFile (const char path, kome::core::Progress progress=NULL)
	opens file More...

bool	closeFile ()
	closes file More...

virtual bool	onOpenSample (Sample sample, kome::core::Progress progress=NULL)=0
	This method is called by openSample method. (abstract method) More...

virtual bool	onCloseSample (Sample *sample)=0
	This method is called by closeSample method. (abstract method) More...

Static Public Member Functions
static void	startLoadingTimer ()
	starts loading timer

static void	stopLoadingTimer ()
	stops loading timer

static double	getTotalLoadingTime ()
	gets total loading time More...

static int	issueSampleSetId ()
	issues sample set ID More...

Protected Member Functions
virtual bool	onOpenFile (const char path, kome::core::Progress progress=NULL)=0
	This method is called by openFile method. (abstract method) More...

virtual bool	onCloseFile ()=0
	This method is called by closeFile method. (abstract method) More...

Protected Attributes
std::string	m_filePath

std::string	m_fileName

std::vector< Sample * >	m_samples

bool	m_opened

int	m_errorCode

int	m_sampleSetId

Static Protected Attributes
static kome::core::Timer	m_loadingTimer

static int	m_currentSampleSetId = 0

Detailed Description

sample set information management class

Definition at line 29 of file SampleSet.h.

Member Function Documentation

void kome::objects::SampleSet::addSample ( Sample * sample )

adds sample

Parameters

[in] sample sample object to be added

Definition at line 99 of file SampleSet.cpp.

                                           {
     // check the parameter
     if( sample == NULL ) {
         return;
     }
     if( sample->getSampleSet() != this ) {
         LOG_WARN( FMT( "Sample set is different." ) );
         return;
     }
 
     // add
     sample->setSampleIndex( (int)m_samples.size() );
     m_samples.push_back( sample );
 }

Here is the call graph for this function:

bool kome::objects::SampleSet::closeFile ( )

closes file

Returns: If true, it succeeded to close the file

Definition at line 165 of file SampleSet.cpp.

                           {
     if( !m_opened ) {
         return true;
     }
 
     // close
     for( unsigned int i = 0; i < m_samples.size(); i++ ) {
         m_samples[ i ]->closeSample();
     }
     bool ret = onCloseFile();
 
     // clear
     clearSamples();
 
     return ret;
 }

Here is the call graph for this function:

int kome::objects::SampleSet::getErrorCode ( void )

get error code of file access.

Returns: error code.

Definition at line 207 of file SampleSet.cpp.

 {
     return  m_errorCode;
 }

const char * kome::objects::SampleSet::getFileName ( )

gets file name

Returns: file name

Definition at line 74 of file SampleSet.cpp.

                                    {
     return m_fileName.c_str();
 }

const char * kome::objects::SampleSet::getFilePath ( )

gets file path

Returns: file path

Definition at line 69 of file SampleSet.cpp.

                                    {
     return m_filePath.c_str();
 }

unsigned int kome::objects::SampleSet::getNumberOfSamples ( )

gets the nubmer of samples

Returns: the number of samples

Definition at line 115 of file SampleSet.cpp.

                                            {
     return m_samples.size();
 }

Sample * kome::objects::SampleSet::getSample ( const unsigned int index )

gets sample object

Parameters

[in] index sample index

Returns: sample object (If NULL, the index is illegal.)

Definition at line 120 of file SampleSet.cpp.

                                                        {
     if( index >= m_samples.size() ) {
         return NULL;
     }
     return m_samples[ index ];
 }

int kome::objects::SampleSet::getSampleSetId ( )

gets the sample set ID

Returns: sample set ID

Definition at line 51 of file SampleSet.cpp.

                               {
     return m_sampleSetId;
 }

static double kome::objects::SampleSet::getTotalLoadingTime ( )

static

gets total loading time

Returns: total loading time

Definition at line 193 of file SampleSet.cpp.

                                       {
     return m_loadingTimer.getTotalTime();
 }

Here is the call graph for this function:

bool kome::objects::SampleSet::isOpened ( )

judges whther this sample set file is opened or not

Returns: If true, this sample set file is opened.

Definition at line 79 of file SampleSet.cpp.

                          {
     return m_opened;
 }

static int kome::objects::SampleSet::issueSampleSetId ( )

static

issues sample set ID

Returns: sample set ID

Definition at line 198 of file SampleSet.cpp.

                                 {
     int sampleSetId = m_currentSampleSetId;
     m_currentSampleSetId++;
 
     return sampleSetId;
 }

bool kome::objects::SampleSet::onCloseFile ( )

protectedpure virtual

This method is called by closeFile method. (abstract method)

Returns: If true, it succeeded to close the file

bool kome::objects::SampleSet::onCloseSample ( Sample * sample )

pure virtual

This method is called by closeSample method. (abstract method)

Parameters

[in,out] sample sample object to be closed (If NULL, closes all samples.)

Returns: If true, it succeeded to close the sample.

bool kome::objects::SampleSet::onOpenFile	(	const char *	path,
		kome::core::Progress *	progress = `NULL`
	)

protectedpure virtual

This method is called by openFile method. (abstract method)

Parameters

[in]	path	file path
[out]	progress	progress bar dialog

Returns: If true, it succeeded to open the file

bool kome::objects::SampleSet::onOpenSample	(	Sample *	sample,
		kome::core::Progress *	progress = `NULL`
	)

pure virtual

This method is called by openSample method. (abstract method)

Parameters

[in,out]	sample	sample object to be opened (If NULL, opens all samples.)
[out]	progress	progress bar dialog

Returns: If true, it succeeded to open the sample.

bool kome::objects::SampleSet::openFile	(	const char *	path,
		kome::core::Progress *	progress = `NULL`
	)

opens file

Parameters

[in]	path	file path
[out]	progress	progress bar dialog

Returns: If true, it succeeded to open the file

Definition at line 128 of file SampleSet.cpp.

                                                                        { // add param @date 2014.07.08 <Mod> M.Izumi
     if( m_opened ) {        // already opened
         return true;
     }
 
     // set file path
     m_filePath = absolutepath( path );
     m_fileName = getfilename( m_filePath.c_str() );
 
     // log
     LOG_DEBUG( FMT( "Open the raw data. [%s]", m_filePath.c_str() ) );
 
     // open
     startLoadingTimer();
 
     bool ret = false;
     try {
         ret = onOpenFile( m_filePath.c_str(), progress );// add param
     }
     catch( ... ) {
         ret = false;
     }
 
     stopLoadingTimer();
 
     if( ret ) {
         m_opened = true;
     }
     else {
         clearSamples();
         LOG_ERROR( FMT( "Failed to open the file.[%s]", m_filePath.c_str() ) );
     }
 
     return ret;
 }

Here is the call graph for this function:

int kome::objects::SampleSet::setErrorCode ( const int errorCode )

set error code of file access.

Parameters

[in] errorCode error code

Definition at line 213 of file SampleSet.cpp.

 {
     m_errorCode = errorCode;
 
     return;
 }

void kome::objects::SampleSet::setFilePath ( const char * path )

sets the file path

Parameters

[in] path file path

Definition at line 56 of file SampleSet.cpp.

                                               {
     m_filePath = NVL( path, "" );
 
     for( unsigned int i = 0; i < m_samples.size(); i++ ) {
         kome::objects::Sample* sample = m_samples[ i ];
         kome::objects::DataGroupNode* root = sample->getRootDataGroupNode();
         if( root != NULL ) {
             root->getProperties().setValue( "File Path", m_filePath.c_str() );
         }
     }
 }

Here is the call graph for this function:

Member Data Documentation

int kome::objects::SampleSet::m_errorCode

protected

error code of file access

Definition at line 61 of file SampleSet.h.

std::string kome::objects::SampleSet::m_fileName

protected

file name

Definition at line 48 of file SampleSet.h.

std::string kome::objects::SampleSet::m_filePath

protected

file path

Definition at line 45 of file SampleSet.h.

kome::core::Timer SampleSet::m_loadingTimer

staticprotected

loading timer

Definition at line 57 of file SampleSet.h.

bool kome::objects::SampleSet::m_opened

protected

opened flag

Definition at line 54 of file SampleSet.h.

std::vector< Sample* > kome::objects::SampleSet::m_samples

protected

samples

Definition at line 51 of file SampleSet.h.

int kome::objects::SampleSet::m_sampleSetId

protected

sample set ID

Definition at line 65 of file SampleSet.h.

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

DataObjects/SampleSet.h
DataObjects/SampleSet.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation