ProteoWizard
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
pwiz::identdata::Serializer_Text Class Reference

Serializer_Text reads in and writes out an id file in tab format. More...

#include <Serializer_Text.hpp>

Classes

struct  Config
 < Controls the format of the text file. More...
 

Public Types

enum  IdField {
  None =0 , Scan =1 , Rt =2 , Mz =3 ,
  Charge =4 , Score =5 , ScoreType =6 , Peptide =7 ,
  Protein =8 , ProteinDescription =9 , Last =ProteinDescription
}
 List of fields available. More...
 

Public Member Functions

 Serializer_Text (const Config &config=Config())
 Constructor with Config.
 
void write (std::ostream &os, const IdentData &mzid, const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0) const
 writes IdentData object to ostream as a text table
 
void read (boost::shared_ptr< std::istream > is, IdentData &mzid) const
 read in IdentData object from a delimited text fromat.
 

Static Public Member Functions

static const std::string * getIdFieldNames ()
 

Private Member Functions

 Serializer_Text (Serializer_Text &)
 
Serializer_Textoperator= (Serializer_Text &)
 

Private Attributes

boost::shared_ptr< Impl > impl_
 

Detailed Description

Serializer_Text reads in and writes out an id file in tab format.

Definition at line 38 of file Serializer_Text.hpp.

Member Enumeration Documentation

◆ IdField

Constructor & Destructor Documentation

◆ Serializer_Text() [1/2]

pwiz::identdata::Serializer_Text::Serializer_Text ( const Config config = Config())

Constructor with Config.

◆ Serializer_Text() [2/2]

pwiz::identdata::Serializer_Text::Serializer_Text ( Serializer_Text )
private

Member Function Documentation

◆ getIdFieldNames()

static const std::string * pwiz::identdata::Serializer_Text::getIdFieldNames ( )
static

◆ write()

void pwiz::identdata::Serializer_Text::write ( std::ostream &  os,
const IdentData mzid,
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
) const

writes IdentData object to ostream as a text table

Referenced by testSerializeWrite().

◆ read()

void pwiz::identdata::Serializer_Text::read ( boost::shared_ptr< std::istream >  is,
IdentData mzid 
) const

read in IdentData object from a delimited text fromat.

Referenced by testSerializeRead().

◆ operator=()

Serializer_Text & pwiz::identdata::Serializer_Text::operator= ( Serializer_Text )
private

Member Data Documentation

◆ impl_

boost::shared_ptr<Impl> pwiz::identdata::Serializer_Text::impl_
private

Definition at line 84 of file Serializer_Text.hpp.


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