File adapter for HUPO PSI TraML files. More...
#include <OpenMS/FORMAT/TraMLFile.h>
Inheritance diagram for TraMLFile:
Public Member Functions | |
| TraMLFile () | |
| Default constructor. | |
| virtual | ~TraMLFile () |
| Destructor. | |
| void | load (const String &filename, TargetedExperiment &id) |
| Loads a map from a TraML file. | |
| void | store (const String &filename, const TargetedExperiment &id) const |
| Stores a map in a TraML file. | |
| 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. | |
Detailed Description
File adapter for HUPO PSI TraML files.
If a critical error occurs due to the missing functionality, Exception::NotImplemented is thrown.
Constructor & Destructor Documentation
| TraMLFile | ( | ) |
Default constructor.
| virtual ~TraMLFile | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| 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.
- Parameters:
-
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.
- Exceptions:
-
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.
- Exceptions:
-
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.
- Exceptions:
-
Exception::UnableToCreateFile is thrown if the file could not be created
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:54 using doxygen 1.7.1 |