pwiz::msdata::Serializer_mz5 Class Reference

MSData <-> MZ5 file serialization. More...

#include <Serializer_mz5.hpp>

List of all members.

Public Member Functions
	Serializer_mz5 (const mz5::Configuration_mz5 &config=mz5::Configuration_mz5())
	Default constructor.
	Serializer_mz5 (const pwiz::msdata::MSDataFile::WriteConfig &config)
	Uses config to generate a Configuration_mz5 instance.
void	write (const std::string &filename, const MSData &msd, const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0) const
	Creates and writes MSData instances to a mz5 file.
void	write (std::ostream &os, const MSData &msd, const pwiz::util::IterationListenerRegistry *iterationListenerRegistry=0) const
	This method is not supported by mz5 since mz5 can not write to ostreams.
void	read (const std::string &filename, MSData &msd) const
	Reads the mz5 file and stores the information in the MSData object.
void	read (boost::shared_ptr< std::istream > is, MSData &msd) const
	This method is not supported by mz5 since mz5 can not read from an istream.

Private Member Functions
	Serializer_mz5 (Serializer_mz5 &)
Serializer_mz5 &	operator= (Serializer_mz5 &)

Private Attributes
boost::shared_ptr< Impl >	impl_

---

Detailed Description

MSData <-> MZ5 file serialization.

Definition at line 40 of file Serializer_mz5.hpp.

---

Constructor & Destructor Documentation

pwiz::msdata::Serializer_mz5::Serializer_mz5

(

const mz5::Configuration_mz5 &

config = mz5::Configuration_mz5()

)

Default constructor.

Parameters:

config

mz5 configuration containing dataset names and different parameters for write support.

pwiz::msdata::Serializer_mz5::Serializer_mz5

(

const pwiz::msdata::MSDataFile::WriteConfig &

config

)

Uses config to generate a Configuration_mz5 instance.

Parameters:

config

pwiz configuration

pwiz::msdata::Serializer_mz5::Serializer_mz5 ( Serializer_mz5 &  )

private

---

Member Function Documentation

void pwiz::msdata::Serializer_mz5::write	(	const std::string &	filename,
		const MSData &	msd,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = 0
	)		const

Creates and writes MSData instances to a mz5 file.

Parameters:

filename	file name
msd	MSData object
iterationListenerRegistry	progress listener

Referenced by test(), and testWriteRead().

void pwiz::msdata::Serializer_mz5::write	(	std::ostream &	os,
		const MSData &	msd,
		const pwiz::util::IterationListenerRegistry *	iterationListenerRegistry = 0
	)		const

This method is not supported by mz5 since mz5 can not write to ostreams.

void pwiz::msdata::Serializer_mz5::read	(	const std::string &	filename,
		MSData &	msd
	)		const

Reads the mz5 file and stores the information in the MSData object.

@þaram filename file anme

Parameters:

msd	MSData object

Referenced by test(), and testWriteRead().

void pwiz::msdata::Serializer_mz5::read	(	boost::shared_ptr< std::istream >	is,
		MSData &	msd
	)		const

This method is not supported by mz5 since mz5 can not read from an istream.

Serializer_mz5& pwiz::msdata::Serializer_mz5::operator= ( Serializer_mz5 &  )

private

---

Member Data Documentation

boost::shared_ptr<Impl> pwiz::msdata::Serializer_mz5::impl_

private

Definition at line 80 of file Serializer_mz5.hpp.

---

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

• /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/msdata/Serializer_mz5.hpp