File adapter for HUPO PSI TraML files. More...
#include <OpenMS/FORMAT/TraMLFile.h>
Public Member Functions | |
TraMLFile () | |
Default constructor. More... | |
virtual | ~TraMLFile () |
Destructor. More... | |
void | load (const String &filename, TargetedExperiment &id) |
Loads a map from a TraML file. More... | |
void | store (const String &filename, const TargetedExperiment &id) const |
Stores a map in a TraML file. More... | |
bool | isSemanticallyValid (const String &filename, StringList &errors, StringList &warnings) |
Checks if a file is valid with respect to the mapping file and the controlled vocabulary. More... | |
![]() | |
XMLFile () | |
Default constructor. More... | |
XMLFile (const String &schema_location, const String &version) | |
Constructor that sets the schema location. More... | |
virtual | ~XMLFile () |
Destructor. More... | |
bool | isValid (const String &filename, std::ostream &os=std::cerr) |
Checks if a file validates against the XML schema. More... | |
const String & | getVersion () const |
return the version of the schema More... | |
![]() | |
ProgressLogger () | |
Constructor. More... | |
~ProgressLogger () | |
Destructor. More... | |
void | setLogType (LogType type) const |
Sets the progress log that should be used. The default type is NONE! More... | |
LogType | getLogType () const |
Returns the type of progress log being used. More... | |
void | startProgress (SignedSize begin, SignedSize end, const String &label) const |
Initializes the progress display. More... | |
void | setProgress (SignedSize value) const |
Sets the current progress. More... | |
void | endProgress () const |
Ends the progress display. More... | |
Additional Inherited Members | |
![]() | |
enum | LogType { CMD, GUI, NONE } |
Possible log types. More... | |
![]() | |
void | parse_ (const String &filename, XMLHandler *handler) |
Parses the XML file given by filename using the handler given by handler . More... | |
void | save_ (const String &filename, XMLHandler *handler) const |
Stores the contents of the XML handler given by handler in the file given by filename . More... | |
void | enforceEncoding_ (const String &encoding) |
![]() | |
String | schema_location_ |
XML schema file location. More... | |
String | schema_version_ |
Version string. More... | |
String | enforced_encoding_ |
Encoding string that replaces the encoding (system dependend or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml. More... | |
![]() | |
LogType | type_ |
SignedSize | begin_ |
SignedSize | end_ |
SignedSize | value_ |
QProgressDialog * | dlg_ |
StopWatch | stop_watch_ |
time_t | last_invoke_ |
![]() | |
static int | recursion_depth_ |
File adapter for HUPO PSI TraML files.
If a critical error occurs due to the missing functionality, Exception::NotImplemented is thrown.
TraMLFile | ( | ) |
Default constructor.
|
virtual |
Destructor.
bool isSemanticallyValid | ( | const String & | filename, |
StringList & | errors, | ||
StringList & | warnings | ||
) |
Checks if a file is valid with respect to the mapping file and the controlled vocabulary.
filename | File name of the file to be checked. |
errors | Errors during the validation are returned in this output parameter. |
warnings | Warnings during the validation are returned in this output parameter. |
Exception::FileNotFound | is thrown if the file could not be opened |
void load | ( | const String & | filename, |
TargetedExperiment & | id | ||
) |
Loads a map from a TraML file.
Exception::FileNotFound | is thrown if the file could not be opened |
Exception::ParseError | is thrown if an error occurs during parsing |
void store | ( | const String & | filename, |
const TargetedExperiment & | id | ||
) | const |
Stores a map in a TraML file.
Exception::UnableToCreateFile | is thrown if the file could not be created |
OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:31 using doxygen 1.8.5 |