OpenMS
LayerStoreDataConsensusMapAll Class Reference

Visitor which can save a full ConsensusMap; subsequently the data can be stored to a file. More...

#include <OpenMS/VISUAL/VISITORS/LayerStoreData.h>

Inheritance diagram for LayerStoreDataConsensusMapAll:
[legend]
Collaboration diagram for LayerStoreDataConsensusMapAll:
[legend]

Public Member Functions

 LayerStoreDataConsensusMapAll ()
 
void saveToFile (const String &filename, const ProgressLogger::LogType lt) const override
 
void storeFullCM (const ConsensusMap &cm)
 
- Public Member Functions inherited from LayerStoreData
 LayerStoreData (FileTypeList supported_storage_formats)
 
virtual ~LayerStoreData ()=default
 virtual D'tor for proper cleanup of derived classes' members More...
 
FileTypeList getSupportedFileFormats () const
 Which formats are supported when writing the file? More...
 

Private Attributes

const ConsensusMapfull_cm_ = nullptr
 pointer to the full data, when storeFullExperiment() was called More...
 

Additional Inherited Members

- Protected Member Functions inherited from LayerStoreData
FileTypes::Type getSupportedExtension_ (const String &filename) const
 extracts the supported extension (converting UNKNOWN to first item in storage_formats_) or throws an Exception::UnableToCreateFile More...
 
- Protected Attributes inherited from LayerStoreData
FileTypeList storage_formats_
 file formats which can hold the data from the layer; The first item should be the preferred/default format More...
 

Detailed Description

Visitor which can save a full ConsensusMap; subsequently the data can be stored to a file.

Since only a pointer is stored internally, make sure the lifetime of the ConsensusMap exceeds this visitor.

Constructor & Destructor Documentation

◆ LayerStoreDataConsensusMapAll()

Member Function Documentation

◆ saveToFile()

void saveToFile ( const String filename,
const ProgressLogger::LogType  lt 
) const
overridevirtual

Save the internal data to a file. The filename's suffix determines the file format. It must be one of getSupportedFileFormats() or UNKNOWN. If the filename's suffix is unknown, the first item from getSupportedFileFormats() determines the storage format.

Parameters
filenameA relative or absolute path+filename. Its suffix determines the format.
ltShow a progress bar in the GUI?
Exceptions
Exception::UnableToCreateFileif the extension of filename is neither in getSupportedFileFormats() nor UNKNOWN.

Implements LayerStoreData.

◆ storeFullCM()

void storeFullCM ( const ConsensusMap cm)

Member Data Documentation

◆ full_cm_

const ConsensusMap* full_cm_ = nullptr
private

pointer to the full data, when storeFullExperiment() was called