kome::io::mzml::MzmlSampleSet Class Reference

mzML sample set class More...

#include <MzmlSampleSet.h>

Inheritance diagram for kome::io::mzml::MzmlSampleSet:

Collaboration diagram for kome::io::mzml::MzmlSampleSet:

Public Member Functions
	MzmlSampleSet ()
	constructor
virtual	~MzmlSampleSet ()
	destructor
FILE *	getFile ()
	gets file descriptor More...
virtual bool	onOpenSample (kome::objects::Sample *sample, kome::core::Progress *progress=NULL)
	This method is called by openTreatment method. (override method) More...
virtual bool	onCloseSample (kome::objects::Sample *sample)
	This method is called by closeTreatment method. (override method) More...

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

Protected Attributes
FILE *	m_fp

Detailed Description

mzML sample set class

Definition at line 24 of file MzmlSampleSet.h.

Member Function Documentation

FILE * kome::io::mzml::MzmlSampleSet::getFile

(

)

gets file descriptor

Returns

file descriptor

Definition at line 39 of file MzmlSampleSet.cpp.

                             {
    return m_fp;
}

bool kome::io::mzml::MzmlSampleSet::onCloseFile ( )

protectedvirtual

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

Parameters

path

file path

Returns

If true, it succeeded to close the file

Definition at line 53 of file MzmlSampleSet.cpp.

                                {
    if( m_fp != NULL ) {
        fclose( m_fp );
        m_fp = NULL;
    }
    return true;
}

bool kome::io::mzml::MzmlSampleSet::onCloseSample ( kome::objects::Sample *  sample )

virtual

This method is called by closeTreatment method. (override method)

Parameters

sample

sample object to be closed (If NULL, closes all samples.)

Returns

If true, it succeeded to close the sample.

Definition at line 71 of file MzmlSampleSet.cpp.

                                                             {
    if( m_fp != NULL ) {
        fclose( m_fp );
        m_fp = NULL;
    }
    return true;
}

bool kome::io::mzml::MzmlSampleSet::onOpenFile ( const char *  path, kome::core::Progress *  progress = NULL  )

protectedvirtual

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

Parameters

path	file path
progress

Returns

If true, it succeeded to open the file

Definition at line 44 of file MzmlSampleSet.cpp.

                                                                             { // add param @date 2014.07.08 <Mod> M.Izumi
    // create sample
    MzmlSample* sample = new MzmlSample( this );
    addSample( sample );

    return true;
}

bool kome::io::mzml::MzmlSampleSet::onOpenSample ( kome::objects::Sample *  sample, kome::core::Progress *  progress = NULL  )

virtual

This method is called by openTreatment method. (override method)

Parameters

sample

sample object to be opened (If NULL, opens all samples.)

Returns

If true, it succeeded to open the sample.

Definition at line 62 of file MzmlSampleSet.cpp.

                                                                                        {       // add param @date 2014.07.08 <Mod> M.Izumi
    if( m_fp == NULL ) {
        m_fp = fileopen( getFilePath(), "r" );
    }
    
    return ( m_fp != NULL );
}

Member Data Documentation

FILE* kome::io::mzml::MzmlSampleSet::m_fp

protected

file descriptor

Definition at line 40 of file MzmlSampleSet.h.

---

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

• MzmlIOPlugin/MzmlSampleSet.h
• MzmlIOPlugin/MzmlSampleSet.cpp