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

Inheritance diagram for pwiz::tradata::TraDataFile:

Classes
struct	WriteConfig
	configuration for write() More...

Public Member Functions
	TraDataFile (const std::string &filename, const Reader *reader=0)
	constructs TraData object backed by file; reader==0 -> use DefaultReaderList
void	write (const std::string &filename, const WriteConfig &config=WriteConfig())
	member write function
Public Member Functions inherited from pwiz::tradata::TraData
bool	empty () const
	returns true iff all members are empty
const std::string &	version () const
	returns the version of this traML document; for a document created programmatically, the version is the current release version of traML; for a document created from a file/stream, the version is the schema version read from the file/stream
	TraData ()
virtual	~TraData ()

Static Public Member Functions
static void	write (const TraData &msd, const std::string &filename, const WriteConfig &config=WriteConfig())
	static write function for any TraData object;

Additional Inherited Members
Public Attributes inherited from pwiz::tradata::TraData
std::string	id
	for internal use: not currently in the schema
std::vector< CV >	cvs
	List of controlled vocabularies used in a TraML document note: one of the <cv> elements in this list MUST be the PSI MS controlled vocabulary.
std::vector< ContactPtr >	contactPtrs
	List of contacts referenced in the generation or validation of transitions.
std::vector< Publication >	publications
	List of publications from which the transitions were collected or wherein they are published.
std::vector< InstrumentPtr >	instrumentPtrs
	List of instruments on which transitions are validated.
std::vector< SoftwarePtr >	softwarePtrs
	List of software packages used in the generation of one of more transitions described in the document.
std::vector< ProteinPtr >	proteinPtrs
	List of proteins for which one or more transitions are intended to identify.
std::vector< PeptidePtr >	peptidePtrs
	List of compounds (including peptides) for which one or more transitions are intended to identify.
std::vector< CompoundPtr >	compoundPtrs
std::vector< Transition >	transitions
	List of transitions.
TargetList	targets
	List of precursor m/z targets to include or exclude.
Protected Attributes inherited from pwiz::tradata::TraData
std::string	version_

Detailed Description

TraData object plus file I/O.

Definition at line 37 of file TraDataFile.hpp.

Constructor & Destructor Documentation

pwiz::tradata::TraDataFile::TraDataFile	(	const std::string &	filename,
		const Reader *	reader = `0`
	)

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

static void pwiz::tradata::TraDataFile::write	(	const TraData &	msd,
		const std::string &	filename,
		const WriteConfig &	config = `WriteConfig()`
	)

static

static write function for any TraData object;

Referenced by test().

void pwiz::tradata::TraDataFile::write	(	const std::string &	filename,
		const WriteConfig &	config = `WriteConfig()`
	)

member write function

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