ProteoWizard
Classes | Public Member Functions | Static Public Member Functions
pwiz::proteome::ProteomeDataFile Struct Reference

ProteomeData object plus file I/O. More...

#include <ProteomeDataFile.hpp>

Inheritance diagram for pwiz::proteome::ProteomeDataFile:
pwiz::proteome::ProteomeData

List of all members.

Classes

struct  WriteConfig
 configuration for write() More...

Public Member Functions

 ProteomeDataFile (const std::string &uri, bool indexed=false)
 constructs ProteomeData object backed by file; indexed==true -> uses DefaultReaderList with indexing
 ProteomeDataFile (const std::string &uri, const Reader &reader)
 constructs ProteomeData object backed by file using the specified reader
void write (const std::string &uri, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 member write function
- Public Member Functions inherited from pwiz::proteome::ProteomeData
 ProteomeData ()
virtual ~ProteomeData ()
bool empty () const

Static Public Member Functions

static void write (const ProteomeData &pd, const std::string &uri, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 static write function for any ProteomeData object; iterationListenerRegistry may be used for progress updates

Additional Inherited Members

- Public Attributes inherited from pwiz::proteome::ProteomeData
std::string id
ProteinListPtr proteinListPtr

Detailed Description

ProteomeData object plus file I/O.

Definition at line 39 of file ProteomeDataFile.hpp.


Constructor & Destructor Documentation

pwiz::proteome::ProteomeDataFile::ProteomeDataFile ( const std::string &  uri,
bool  indexed = false 
)

constructs ProteomeData object backed by file; indexed==true -> uses DefaultReaderList with indexing

pwiz::proteome::ProteomeDataFile::ProteomeDataFile ( const std::string &  uri,
const Reader reader 
)

constructs ProteomeData object backed by file using the specified reader


Member Function Documentation

static void pwiz::proteome::ProteomeDataFile::write ( const ProteomeData pd,
const std::string &  uri,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)
static

static write function for any ProteomeData object; iterationListenerRegistry may be used for progress updates

Referenced by validateWriteRead().

void pwiz::proteome::ProteomeDataFile::write ( const std::string &  uri,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)

member write function


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