Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

ANDIHandler Class Template Reference

#include <OpenMS/FORMAT/HANDLERS/ANDIHandler.h>

List of all members.


Detailed Description

template<typename MapType>
class OpenMS::Internal::ANDIHandler< MapType >

Read-only File handler for ANDIFile (Version 1.0).

MapType has to be a MSExperiment or have the same interface.

Note:
Do not use this class directly. It is only needed for ANDIFile.

meta value handling

enum  userParamsID {
  CONTACT = 0, PROC, ANDI_ERROR, CALHIST,
  CALTIMES, INSTSERIAL, INSTCOMMENTS, INSTSOFTWARE,
  INSTFIRMWARE, INSTOS, INSTID, INLETTEMP,
  IONMODEADD, SRCTEMP, ACCPOT, INSTPARAMS,
  DETPOT, DETENTRPOT, NUM_PARAM
}
 index of meta value string More...
static const std::string user_params_ []
 strings used as meta values
static const std::string description_ []
 description of the meta values

Public Member Functions

void parse (std::string file_name)
 read the ANDIFile using the ANDI/MS-NETCDF library
Constructors and destructor
 ANDIHandler (MapType &exp, const ProgressLogger &logger)
virtual ~ANDIHandler ()
 Destructor.

Protected Member Functions

String string_ (char *input)
 convert all char* struct members to string in case member is NULL
float float_ (float input, float def=0.0f)
 check all float struct members in case member is negative
int int_ (int input, int def=0)
 check all int struct members in case member is negative
Handlers for each NETCDF struct
void getAdminData_ (MS_Admin_Data *admin_data)
 fill administration data with admin_data
void getSampleData_ (MS_Sample_Data *sample_data)
 fill sample data with sample_data
void getTestData_ (MS_Test_Data *test_data)
 fill test data with test_data
void getInstrumentData_ (MS_Instrument_Data *inst_data)
 fill instrument data with first instrument of inst_data
void getRawPerScan_ (MS_Raw_Per_Scan *scan_data, MS_Raw_Data_Global *global_data)
 fill scan data with scan_data and global_data

Protected Attributes

MapType & exp_
 map pointer for reading
IonSource::Polarity pol_
 Scan polarity.
const ProgressLoggerlogger_
 Progress logging helper class.

Member Enumeration Documentation

enum userParamsID [protected]

index of meta value string

Enumerator:
CONTACT 
PROC 
ANDI_ERROR 
CALHIST 
CALTIMES 
INSTSERIAL 
INSTCOMMENTS 
INSTSOFTWARE 
INSTFIRMWARE 
INSTOS 
INSTID 
INLETTEMP 
IONMODEADD 
SRCTEMP 
ACCPOT 
INSTPARAMS 
DETPOT 
DETENTRPOT 
NUM_PARAM 


Constructor & Destructor Documentation

ANDIHandler ( MapType &  exp,
const ProgressLogger logger 
) [inline]

virtual ~ANDIHandler (  )  [inline, virtual]

Destructor.


Member Function Documentation

void parse ( std::string  file_name  )  [inline]

read the ANDIFile using the ANDI/MS-NETCDF library

void getAdminData_ ( MS_Admin_Data *  admin_data  )  [inline, protected]

fill administration data with admin_data

void getSampleData_ ( MS_Sample_Data *  sample_data  )  [inline, protected]

fill sample data with sample_data

void getTestData_ ( MS_Test_Data *  test_data  )  [inline, protected]

fill test data with test_data

void getInstrumentData_ ( MS_Instrument_Data *  inst_data  )  [inline, protected]

fill instrument data with first instrument of inst_data

void getRawPerScan_ ( MS_Raw_Per_Scan *  scan_data,
MS_Raw_Data_Global *  global_data 
) [inline, protected]

fill scan data with scan_data and global_data

String string_ ( char *  input  )  [inline, protected]

convert all char* struct members to string in case member is NULL

float float_ ( float  input,
float  def = 0.0f 
) [inline, protected]

check all float struct members in case member is negative

unset member usually indicated by value -9999

int int_ ( int  input,
int  def = 0 
) [inline, protected]

check all int struct members in case member is negative

unset member usually indicated by value -9999


Member Data Documentation

MapType& exp_ [protected]

map pointer for reading

IonSource::Polarity pol_ [protected]

Scan polarity.

const std::string user_params_ [inline, static, protected]

Initial value:

 {"ContactPosition",
      "ProcessingNumer", "ErrorLog", "CalibrationHistory", "NumOfCalibrations",
      "InstSerial", "InstComments", "InstSoftware", "InstFirmware", "InstOS", "InstID",
      "InletTemp", "IonModeAdd", "SrcTemp", "AccPot", "InstParams", "DetPot", "DetEntrPot"}
strings used as meta values

const std::string description_ [inline, static, protected]

Initial value:

 {"Position of the contact person",
      "number of times processed", "Processing Method error log", "history of calibration",
      "number of times calibrated", "Instrument serial number", "Instrument id comments",
      "Instrument software revision", "Instrument firmware revision",
      "Operating system revision", "Instrument ProteinIdentification code",
      "Spectrometer inlet temperature", "Additional ionization mode information",
      "Ionization source temperature", "Accelerating Potential",
      "Instrument parameter comments", "Detector potential", "Detector entrance potential"}
description of the meta values

const ProgressLogger& logger_ [protected]

Progress logging helper class.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:49 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1