interface for file readers
More...
#include <Reader.hpp>
List of all members.
Public Member Functions |
| bool | accept (const std::string &filename, const std::string &head) const |
| | return true iff Reader recognizes the file as one it should handle
|
| virtual std::string | identify (const std::string &filename, const std::string &head) const =0 |
| | return file type iff Reader recognizes the file, else empty;
|
| virtual void | read (const std::string &filename, const std::string &head, TraData &result, int runIndex=0) const =0 |
| | fill in the TraData structure from the first (or only) sample
|
| virtual void | read (const std::string &filename, const std::string &head, std::vector< TraDataPtr > &results) const =0 |
| | fill in a vector of TraData structures; provides support for multi-run input files
|
| virtual const char * | getType () const =0 |
| | fill in a vector of MSData.Id values; provides support for multi-run input files
|
| virtual | ~Reader () |
Detailed Description
interface for file readers
Definition at line 36 of file Reader.hpp.
Constructor & Destructor Documentation
| virtual pwiz::tradata::Reader::~Reader |
( |
| ) |
|
|
inlinevirtual |
Member Function Documentation
| bool pwiz::tradata::Reader::accept |
( |
const std::string & |
filename, |
|
|
const std::string & |
head |
|
) |
| const |
|
inline |
return true iff Reader recognizes the file as one it should handle
that's not to say one it CAN handle, necessarily, as in Thermo on linux, see comment for identify() below
Definition at line 44 of file Reader.hpp.
{
return (
identify(filename,head).length() != 0);
}
| virtual std::string pwiz::tradata::Reader::identify |
( |
const std::string & |
filename, |
|
|
const std::string & |
head |
|
) |
| const |
|
pure virtual |
return file type iff Reader recognizes the file, else empty;
note: for formats requiring a 3rd party DLL identify() should return true if it recognized the format, even though reading may fail if the 3rd party DLL isn't actually present Reader may filter based on filename and/or head of the file
Implemented in Reader2, Reader2, Reader2, Reader1, Reader1, and Reader1.
| virtual void pwiz::tradata::Reader::read |
( |
const std::string & |
filename, |
|
|
const std::string & |
head, |
|
|
TraData & |
result, |
|
|
int |
runIndex = 0 |
|
) |
| const |
|
pure virtual |
| virtual void pwiz::tradata::Reader::read |
( |
const std::string & |
filename, |
|
|
const std::string & |
head, |
|
|
std::vector< TraDataPtr > & |
results |
|
) |
| const |
|
pure virtual |
| virtual const char* pwiz::tradata::Reader::getType |
( |
| ) |
const |
|
pure virtual |
The documentation for this class was generated from the following file:
- /Users/parag/_Research/pwiz/svn/trunk/pwiz/pwiz/data/tradata/Reader.hpp
