MascotGenericFile

class pyopenms.MascotGenericFile

Bases: object

Cython implementation of _MascotGenericFile

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1MascotGenericFile.html: – Inherits from [‘ProgressLogger’, ‘DefaultParamHandler’]

__init__()

Cython signature: void MascotGenericFile()
Cython signature: void MascotGenericFile(MascotGenericFile &)

Methods

`__init__`	Cython signature: void MascotGenericFile()
`endProgress`	Cython signature: void endProgress() Ends the progress display
`getDefaults`	Cython signature: Param getDefaults() Returns the default parameters
`getHTTPPeakListEnclosure`	Cython signature: libcpp_pair[String,String] getHTTPPeakListEnclosure(const String & filename)
`getLogType`	Cython signature: LogType getLogType() Returns the type of progress log being used
`getName`	Cython signature: String getName() Returns the name
`getParameters`	Cython signature: Param getParameters() Returns the parameters
`getSubsections`	Cython signature: libcpp_vector[String] getSubsections()
`load`	Cython signature: void load(const String & filename, MSExperiment & exp)
`nextProgress`	Cython signature: void nextProgress() Increment progress by 1 (according to range begin-end)
`setLogType`	Cython signature: void setLogType(LogType) Sets the progress log that should be used.
`setName`	Cython signature: void setName(const String &) Sets the name
`setParameters`	Cython signature: void setParameters(Param & param) Sets the parameters
`setProgress`	Cython signature: void setProgress(ptrdiff_t value) Sets the current progress
`startProgress`	Cython signature: void startProgress(ptrdiff_t begin, ptrdiff_t end, String label)
`store`	Cython signature: void store(const String & filename, MSExperiment & experiment)
`updateMembers_`	Cython signature: void updateMembers_() Docu in base class

endProgress(): Cython signature: void endProgress() Ends the progress display

getDefaults(): Cython signature: Param getDefaults() Returns the default parameters

getHTTPPeakListEnclosure()

Cython signature: libcpp_pair[String,String] getHTTPPeakListEnclosure(const String & filename)

Can be used to embed custom content into HTTP submission (when writing only the MGF header in HTTP format and then adding the peaks (in whatever format, e.g. mzXML) enclosed in this body The filename can later be found in the Mascot response

getLogType(): Cython signature: LogType getLogType() Returns the type of progress log being used

getName(): Cython signature: String getName() Returns the name

getParameters(): Cython signature: Param getParameters() Returns the parameters

getSubsections(): Cython signature: libcpp_vector[String] getSubsections()

load()

Cython signature: void load(const String & filename, MSExperiment & exp)

Parameters

filename – File name which the map should be read from
exp – The map which is filled with the data from the given file

Raises

Exception: FileNotFound is thrown if the given file could not be found

nextProgress(): Cython signature: void nextProgress() Increment progress by 1 (according to range begin-end)

setLogType(): Cython signature: void setLogType(LogType) Sets the progress log that should be used. The default type is NONE!

setName(): Cython signature: void setName(const String &) Sets the name

setParameters(): Cython signature: void setParameters(Param & param) Sets the parameters

setProgress(): Cython signature: void setProgress(ptrdiff_t value) Sets the current progress

startProgress(): Cython signature: void startProgress(ptrdiff_t begin, ptrdiff_t end, String label)

store(): Cython signature: void store(const String & filename, MSExperiment & experiment)

updateMembers_(): Cython signature: void updateMembers_() Docu in base class