Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Modules | Namespaces | Classes | Typedefs | Enumerations
Concept

OpenMS concepts (types, macros, ...) More...

Modules

 Class test macros
 These macros are used by the test programs in the subdirectory OpenMS/source/TEST.
 
 Exceptions
 Exceptions.
 
 Condition macros
 Macros used for to enforce preconditions and postconditions.
 

Namespaces

 OpenMS::Constants
 Mathematical and physical constants namespace.
 
 OpenMS::Exception
 Exception namespace
 
 OpenMS::Logger
 Log streams.
 
 OpenMS::Math
 Math namespace.
 

Classes

class  BaseException
 Exception base class. More...
 
class  Precondition
 Precondition failed exception. More...
 
class  Postcondition
 Postcondition failed exception. More...
 
class  MissingInformation
 Not all required information provided. More...
 
class  IndexUnderflow
 Int underflow exception. More...
 
class  SizeUnderflow
 UInt underflow exception. More...
 
class  IndexOverflow
 Int overflow exception. More...
 
class  FailedAPICall
 A call to an external library (other than OpenMS) went wrong. More...
 
class  InvalidRange
 Invalid range exception. More...
 
class  InvalidSize
 Invalid UInt exception. More...
 
class  OutOfRange
 Out of range exception. More...
 
class  InvalidValue
 Invalid value exception. More...
 
class  InvalidParameter
 Exception indicating that an invalid parameter was handed over to an algorithm. More...
 
class  ConversionError
 Invalid conversion exception. More...
 
class  IllegalSelfOperation
 Illegal self operation exception. More...
 
class  NullPointer
 Null pointer argument is invalid exception. More...
 
class  InvalidIterator
 Invalid iterator exception. More...
 
class  IncompatibleIterators
 Incompatible iterator exception. More...
 
class  NotImplemented
 Not implemented exception. More...
 
class  IllegalTreeOperation
 Illegal tree operation exception. More...
 
class  OutOfMemory
 Out of memory exception. More...
 
class  BufferOverflow
 Buffer overflow exception. More...
 
class  DivisionByZero
 Division by zero error exception. More...
 
class  OutOfGrid
 Out of grid exception. More...
 
class  FileNotFound
 File not found exception. More...
 
class  FileNotReadable
 File not readable exception. More...
 
class  FileNotWritable
 File not writable exception. More...
 
class  IOException
 General IOException. More...
 
class  FileEmpty
 File is empty. More...
 
class  IllegalPosition
 Invalid 3-dimensional position exception. More...
 
class  ParseError
 Parse Error exception. More...
 
class  UnableToCreateFile
 Unable to create file exception. More...
 
class  IllegalArgument
 A method or algorithm argument contains illegal values. More...
 
class  ElementNotFound
 Element could not be found exception. More...
 
class  UnableToFit
 Exception used if an error occurred while fitting a model to a given dataset. More...
 
class  UnableToCalibrate
 Exception used if an error occurred while calibrating a dataset. More...
 
class  DepletedIDPool
 Exception used if no more unique document ID's can be drawn from ID pool. More...
 
class  Factory< FactoryProduct >
 Returns FactoryProduct* based on the name of the desired concrete FactoryProduct. More...
 
class  FactoryBase
 Base class for Factory<T> More...
 
class  LogConfigHandler
 The LogConfigHandler provides the functionality to configure the internal logging of OpenMS algorithms that use the global instances of LogStream. More...
 
struct  LogStreamBuf::StreamStruct
 Holds a stream that is connected to the LogStream. It also includes the minimum and maximum level at which the LogStream redirects messages to this stream. More...
 
struct  LogStreamBuf::LogCacheStruct
 Holds a counter of occurrences and an index for the occurrence sequence of the corresponding log message. More...
 
class  LogStreamBuf
 Stream buffer used by LogStream. More...
 
class  LogStreamNotifier
 
class  LogStream
 Log Stream Class. More...
 
class  SingletonRegistry
 Holds pointers to unique instance of a singleton factory. More...
 
class  StreamHandler
 Provides a central class to register globally used output streams. Currently supported streams are. More...
 
class  UniqueIdGenerator
 A generator for unique ids. More...
 
class  UniqueIdInterface
 A base class defining a common interface for all classes having a unique id. More...
 
struct  VersionInfo::VersionDetails
 
class  VersionInfo
 Version information class. More...
 

Typedefs

typedef OPENMS_INT32_TYPE Int32
 Signed integer type (32bit) More...
 
typedef OPENMS_INT64_TYPE Int64
 Signed integer type (64bit) More...
 
typedef OPENMS_UINT64_TYPE UInt64
 Unsigned integer type (64bit) More...
 
typedef time_t Time
 Time type. More...
 
typedef unsigned int UInt
 Unsigned integer type. More...
 
typedef int Int
 Signed integer type. More...
 
typedef OPENMS_BYTE_TYPE Byte
 Byte type. More...
 
typedef OPENMS_UINT64_TYPE UID
 A unique object ID (as unsigned 64bit type). More...
 
typedef size_t Size
 Size type e.g. used as variable which can hold result of size() More...
 
typedef ptrdiff_t SignedSize
 Signed Size type e.g. used as pointer difference. More...
 

Enumerations

enum  StreamType { FILE, STRING }
 Defines the type of the stream that should be handled. More...
 
enum  { INVALID = 0 }
 This is the invalid unique id (cast it to a UInt64 if you like) More...
 

Detailed Description

OpenMS concepts (types, macros, ...)

Typedef Documentation

typedef OPENMS_BYTE_TYPE Byte

Byte type.

Use this type to represent byte data (8 bit length). A Byte is always unsigned.

typedef int Int

Signed integer type.

typedef OPENMS_INT32_TYPE Int32

Signed integer type (32bit)

typedef OPENMS_INT64_TYPE Int64

Signed integer type (64bit)

typedef ptrdiff_t SignedSize

Signed Size type e.g. used as pointer difference.

typedef size_t Size

Size type e.g. used as variable which can hold result of size()

typedef time_t Time

Time type.

Use this type to represent a point in time (as a synonym for time_t).

typedef OPENMS_UINT64_TYPE UID

A unique object ID (as unsigned 64bit type).

See also
PersistentObject
typedef unsigned int UInt

Unsigned integer type.

typedef OPENMS_UINT64_TYPE UInt64

Unsigned integer type (64bit)

Enumeration Type Documentation

anonymous enum

This is the invalid unique id (cast it to a UInt64 if you like)

It is represented as an enum because static class members lead to bugs and linker errors all the time...

Enumerator
INVALID 
enum StreamType

Defines the type of the stream that should be handled.

Enumerator
FILE 
STRING 

OpenMS / TOPP release 2.0.0 Documentation generated on Fri May 29 2015 17:20:34 using doxygen 1.8.9.1