ProteoWizard
Classes | Public Member Functions | Static Public Member Functions | List of all members
pwiz::identdata::IdentDataFile Struct Reference

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

#include <IdentDataFile.hpp>

Inheritance diagram for pwiz::identdata::IdentDataFile:
pwiz::identdata::IdentData pwiz::identdata::Identifiable

Classes

struct  WriteConfig
 configuration for write() More...
 

Public Member Functions

 IdentDataFile (const std::string &filename, const Reader *reader=0, const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0, bool ignoreSequenceCollectionAndAnalysisData=false)
 constructs IdentData object backed by file; reader==0 -> use DefaultReaderList More...
 
void write (const std::string &filename, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 member write function More...
 
void write (std::ostream &os, const std::string &filename, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 member write function More...
 
- Public Member Functions inherited from pwiz::identdata::IdentData
 IdentData (const std::string &id_="", const std::string &creationDate_="")
 
bool empty () const
 
const std::string & version () const
 returns the version of this mzIdentML document; for a document created programmatically, the version is the current release version of mzIdentML; for a document created from a file/stream, the version is the schema version read from the file/stream More...
 
- Public Member Functions inherited from pwiz::identdata::Identifiable
 Identifiable (const std::string &id_="", const std::string &name_="")
 
virtual ~Identifiable ()
 

Static Public Member Functions

static void write (const IdentData &mzid, const std::string &filename, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 static write function for any IdentData object; More...
 
static void write (const IdentData &mzid, const std::string &filename, std::ostream &os, const WriteConfig &config=WriteConfig(), const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0)
 static write function for any IdentData object; More...
 

Additional Inherited Members

- Public Attributes inherited from pwiz::identdata::IdentData
std::string creationDate
 
std::vector< CVcvs
 
std::vector< AnalysisSoftwarePtr > analysisSoftwareList
 
Provider provider
 
std::vector< ContactPtr > auditCollection
 
AnalysisSampleCollection analysisSampleCollection
 
SequenceCollection sequenceCollection
 
AnalysisCollection analysisCollection
 
AnalysisProtocolCollection analysisProtocolCollection
 
DataCollection dataCollection
 
std::vector< BibliographicReferencePtr > bibliographicReference
 
- Public Attributes inherited from pwiz::identdata::Identifiable
std::string id
 
std::string name
 
- Protected Attributes inherited from pwiz::identdata::IdentData
std::string version_
 

Detailed Description

IdentData object plus file I/O.

Definition at line 39 of file IdentDataFile.hpp.

Constructor & Destructor Documentation

§ IdentDataFile()

pwiz::identdata::IdentDataFile::IdentDataFile ( const std::string &  filename,
const Reader reader = 0,
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0,
bool  ignoreSequenceCollectionAndAnalysisData = false 
)

constructs IdentData object backed by file; reader==0 -> use DefaultReaderList

Member Function Documentation

§ write() [1/4]

static void pwiz::identdata::IdentDataFile::write ( const IdentData mzid,
const std::string &  filename,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)
static

static write function for any IdentData object;

Referenced by testFile().

§ write() [2/4]

void pwiz::identdata::IdentDataFile::write ( const std::string &  filename,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)

member write function

§ write() [3/4]

static void pwiz::identdata::IdentDataFile::write ( const IdentData mzid,
const std::string &  filename,
std::ostream &  os,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)
static

static write function for any IdentData object;

§ write() [4/4]

void pwiz::identdata::IdentDataFile::write ( std::ostream &  os,
const std::string &  filename,
const WriteConfig config = WriteConfig(),
const pwiz::util::IterationListenerRegistry iterationListenerRegistry = 0 
)

member write function


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