OpenMS::Internal Namespace Reference

Namespace used to hide implementation details from users. More...

Namespaces
namespace	ClassTest
	Namespace for class tests.
Classes
class	DIntervalBase
	A base class for D-dimensional interval. More...
struct	FileMapping
	Maps input/output files to filenames for the external program. More...
struct	MappingParam
	Filename mappings for all input/output files. More...
struct	ToolDescriptionInternal
	ToolDescription Class. More...
struct	ToolExternalDetails
struct	ToolDescription
class	IntensityIteratorWrapper
	An iterator wrapper to access peak intensities instead of the peak itself. More...
class	AcqusHandler
	Read-only acqus File handler for XMass Analysis. More...
class	FidHandler
	Read-only fid File handler for XMass Analysis. More...
class	MascotXMLHandler
	Handler that is used for parsing MascotXML data. More...
class	MzDataHandler
	XML handler for MzDataFile. More...
class	MzIdentMLHandler
	XML handler for MzIdentMLFile. More...
class	MzMLHandler
	XML handler for MzMLFile. More...
class	MzQuantMLHandler
	XML handler for MzQuantMLFile. More...
class	MzXMLHandler
	XML handlers for MzXMLFile. More...
class	ParamXMLHandler
	XML Handler for Param files. More...
class	PTMXMLHandler
	Handler that is used for parsing PTMXML data. More...
class	ToolDescriptionHandler
	XML handler for ToolDescriptionFile. More...
class	TraMLHandler
	XML handler for TraMLFile. More...
class	UnimodXMLHandler
	Handler that is used for parsing XTandemXML data. More...
class	StringManager
	Helper class for XML parsing that handles the memory management for conversions of Xerces strings. More...
class	XMLHandler
	Base class for XML handlers. More...
struct	XTandemInfileNote
	Note representation of bioml structure used by XTandem. More...
class	XTandemInfileXMLHandler
	Handler that is used for parsing XTandemXML data. More...
class	MzDataValidator
	Semantically validates MzXML files. More...
class	MzIdentMLValidator
	Semantically validates MzXML files. More...
class	MzMLValidator
	Semantically validates MzXML files. More...
class	MzQuantMLValidator
	Semantically validates MzQuantML files. More...
class	SemanticValidator
	Semantically validates XML files using CVMappings and a ControlledVocabulary. More...
class	TraMLValidator
	Semantically validates MzXML files. More...
class	XMLFile
	Base class for loading/storing XML files that have a handler derived from XMLHandler. More...
class	OpenMSXMLFormatTarget
class	AreaIterator
	Forward iterator for an area of peaks in an experiment. More...
struct	IntensityLess
	Comparator that allows to compare the indices of two peaks by their intensity. More...
struct	IntensityIterator
	Intensity iterator for a FeatureFinderDefs::IndexSet. More...
struct	MzIterator
	m/z iterator for a FeatureFinderDefs::IndexSet More...
struct	RtIterator
	Retention time iterator for a FeatureFinderDefs::IndexSet. More...
class	Spectrum1DPrefDialog
	Preferences dialog for Spectrum1DWidget. More...
class	Spectrum2DPrefDialog
	Preferences dialog for Spectrum2DWidget. More...
class	Spectrum3DPrefDialog
	Preferences dialog for Spectrum3DWidget. More...
class	TOPPViewPrefDialog
	Preferences dialog for TOPPView. More...
class	ListTable
class	ListEditorDelegate
	Internal delegate class. More...
class	ParamEditorDelegate
	Internal delegate class for QTreeWidget. More...
class	ParamTree
	QTreeWidget that emits a signal whenever a new row is selected. More...
struct	OpenMSOSInfo
Enumerations
enum	OpenMS_OS { OS_UNKNOWN, OS_MACOS, OS_WINDOWS, OS_LINUX }
enum	OpenMS_Architecture { ARCH_UNKOWN, ARCH_32BIT, ARCH_64BIT }
Functions
bool	PermutScoreComparator (const CompNovoIdentificationBase::Permut &p1, const CompNovoIdentificationBase::Permut &p2)
template<UInt D>
std::ostream &	operator<< (std::ostream &os, const DIntervalBase< D > &rhs)
	Print the contents to a stream.
template<typename IteratorT >
IntensityIteratorWrapper < IteratorT >	intensityIteratorWrapper (const IteratorT &rhs)
	make-function so that we need no write out all those type names to get the wrapped iterator.
void	writeXMLEscape (const String &to_escape, std::ostream &os)
	Escapes a string to be storable into an XML File.
String	writeXMLEscape (const String &to_escape)
	Escapes a string and returns the escaped string.
static OpenMSOSInfo	getOSInfo ()
Variables
const char *	OpenMS_locale
std::string	OpenMS_OSNames [] = {"unkown", "MacOS", "Windows", "Linux"}
std::string	OpenMS_ArchNames [] = {"unkown", "32bit", "64bit"}

---

Detailed Description

Namespace used to hide implementation details from users.

---

Enumeration Type Documentation

enum OpenMS_Architecture

Enumerator:

ARCH_UNKOWN
ARCH_32BIT
ARCH_64BIT

enum OpenMS_OS

Enumerator:

OS_UNKNOWN
OS_MACOS
OS_WINDOWS
OS_LINUX

---

Function Documentation

static OpenMSOSInfo OpenMS::Internal::getOSInfo

(

)

[static]

References OpenMSOSInfo::arch, OpenMSOSInfo::os, and OpenMSOSInfo::os_version.

IntensityIteratorWrapper<IteratorT> OpenMS::Internal::intensityIteratorWrapper

(

const IteratorT &

rhs

)

make-function so that we need no write out all those type names to get the wrapped iterator.

Referenced by MorphologicalFilter::filter().

std::ostream& OpenMS::Internal::operator<<	(	std::ostream &	os,
		const DIntervalBase< D > &	rhs
	)

Print the contents to a stream.

bool OpenMS::Internal::PermutScoreComparator	(	const CompNovoIdentificationBase::Permut &	p1,
		const CompNovoIdentificationBase::Permut &	p2
	)

String OpenMS::Internal::writeXMLEscape

(

const String &

to_escape

)

Escapes a string and returns the escaped string.

Some characters must be escaped which are allowed in user params. E.g. > and & are not in XML and need to be escaped. Parsing those escaped strings is automatically done by xerces

void OpenMS::Internal::writeXMLEscape	(	const String &	to_escape,
		std::ostream &	os
	)

Escapes a string to be storable into an XML File.

Some characters must be escaped which are allowed in user params. E.g. > and & are not in XML and need to be escaped. Parsing those escaped strings is automatically done by xerces

---

Variable Documentation

std::string OpenMS_ArchNames[] = {"unkown", "32bit", "64bit"}

Referenced by OpenMSOSInfo::getArchAsString().

const char* OpenMS_locale

Used to set the locale to "C", to avoid problems on machines with incompatible locale settings (this overwrites the locale setting of the environment!)

std::string OpenMS_OSNames[] = {"unkown", "MacOS", "Windows", "Linux"}

Referenced by OpenMSOSInfo::getOSAsString().