MzmlIOPluginFunctions.h File Reference

interfaces of MzmlIO plug-in function More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
kome::objects::Variant	openMzml (kome::objects::Parameters *params)
	open mzml file More...
kome::objects::Variant	saveMzml (kome::objects::Parameters *params)
	save mzml file More...

Detailed Description

interfaces of MzmlIO plug-in function

Author

S.Tanaka

Date

2009.03.09

Copyright(C) 2006-2014 Eisai Co., Ltd. All rights reserved.

Definition in file MzmlIOPluginFunctions.h.

Function Documentation

kome::objects::Variant openMzml

(

kome::objects::Parameters *

params

)

open mzml file

Parameters

params

parameters object. (This object has path information.)

Returns

return value. (Sample Object)

Definition at line 33 of file MzmlIOPluginFunctions.cpp.

                                                             {
    // return value
    kome::objects::Variant ret;
    ret.type = kome::objects::Variant::SAMPLE_SET;
    ret.prim.pt = NULL;

    // get path
    const char* path = kome::plugin::PluginCallTool::getPath( params );
    if( path == NULL ) {
        return ret;
    }

    // open
    MzmlSampleSet* sampleSet = new MzmlSampleSet();

    // set file
    ret.prim.pt = sampleSet;

    return ret;
}

kome::objects::Variant saveMzml

(

kome::objects::Parameters *

params

)

save mzml file

Parameters

params

parameters object. (This object has spectrum group and path information.)

Returns

return value. (If it succeeded to save the file, this function returns ture. [bool])

Definition at line 55 of file MzmlIOPluginFunctions.cpp.

                                                             {
    // return value
    kome::objects::Variant ret;
    ret.type = kome::objects::Variant::BOOL;
    ret.prim.boolVal = false;

    // gets parameters
    kome::objects::DataSet* dataSet = kome::plugin::PluginCallTool::getDataSet( params );
    if( dataSet == NULL ) {
        return ret;
    }

    char* path = kome::plugin::PluginCallTool::getPath( params );
    if( path == NULL ) {
        return ret;
    }

    kome::core::Progress* progress = kome::plugin::PluginCallTool::getProgress( params );
    if( progress == NULL ) {
        progress = &kome::core::Progress::getIgnoringProgress();
    }

    kome::objects::SettingParameterValues* saveSettings = kome::plugin::PluginCallTool::getSettingValues( params );  // @date 2012/08/21 <Add> FUJITA
       
    // write
    MzmlManager& mgr = MzmlManager::getInstance();
    ret.prim.boolVal = mgr.exportDataSet( path, *dataSet, *progress, saveSettings );
    return ret;
}

Here is the call graph for this function: