ms_distiller_sub_project Class Reference

The details of a Distiller multifile subproject. More...

#include <ms_distiller_sub_project.hpp>

Public Member Functions
virtual bool	getHavePeakList () const
	Return true if the subproject has any peak lists.
virtual int	getId () const
	Return the number, within the subproject file, used in the name of the search list stream.
virtual std::string	getName () const
	Return the name of the subproject.
virtual std::string	getProjectRelativePath () const
	Return the relative path and filename to the raw file in the subproject.
virtual std::string	getRawAbsolutePath () const
	Return the absolute path and filename to the raw file in the subproject.
virtual int	getRawFormat () const
	Return the format type of the raw files in the subproject.
virtual std::string	getRawRelativePath () const
	Return the relative path and filename to the raw file in the subproject.
virtual int	getRawSampleNumber () const
	Return the raw sample number of the subproject.
virtual std::string	getType () const
	Return the type of data the subproject is created from.

Static Public Member Functions
static std::string	getResultsListStreamName ()
	Return the name of the stream, within the subproject file, used for the search list.

Detailed Description

The details of a Distiller multifile subproject.

A list of these is stored in XML in the Distiller master project file.

Member Function Documentation

getHavePeakList()

bool getHavePeakList ( ) const

virtual

Return true if the subproject has any peak lists.

Returns

True if the subproject has any peak lists.

getId()

int getId ( ) const

virtual

Return the number, within the subproject file, used in the name of the search list stream.

Returns

The number used in the name of the search list stream.

getName()

std::string getName ( ) const

virtual

Return the name of the subproject.

Returns

The name of the subproject.

getProjectRelativePath()

std::string getProjectRelativePath ( ) const

virtual

Return the relative path and filename to the raw file in the subproject.

Returns

The relative path and filename to the raw file in the subproject.

getRawAbsolutePath()

std::string getRawAbsolutePath ( ) const

virtual

Return the absolute path and filename to the raw file in the subproject.

Returns

The absolute path and filename to the raw file in the subproject.

getRawFormat()

int getRawFormat ( ) const

virtual

Return the format type of the raw files in the subproject.

Returns

The format type of the raw files in the subproject.

getRawRelativePath()

std::string getRawRelativePath ( ) const

virtual

Return the relative path and filename to the raw file in the subproject.

Returns

The relative path and filename to the raw file in the subproject.

getRawSampleNumber()

int getRawSampleNumber ( ) const

virtual

Return the raw sample number of the subproject.

Returns

The raw sample number of the subproject.

getResultsListStreamName()

std::string getResultsListStreamName ( )

static

Return the name of the stream, within the subproject file, used for the search list.

Returns

The name of the stream containing the results list data.

getType()

std::string getType ( ) const

virtual

Return the type of data the subproject is created from.

Returns

The type of data the subproject is created from, "project" or "raw".

---

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

• ms_distiller_sub_project.hpp
• ms_distiller_sub_project.cpp