 |
Matrix Science Mascot Parser toolkit
|
|
|
Matrix Science Mascot Parser toolkit
|
|
A class that represents a base parametersType.
More...
#include <ms_xml_parameters.hpp>
Public Member Functions | |
| ms_xml_parameters () | |
| Default constructor. | |
| ms_xml_parameters (const ms_xml_parameters &src) | |
| Copying constructor. | |
| virtual | ~ms_xml_parameters () |
| Destructor. | |
| virtual void | clearParameters ()=0 |
| Deletes all parameters from the list. | |
| void | defaultValues () |
| Call this member if you want to start again. | |
| virtual bool | deleteParameterByName (const char *name)=0 |
| Remove a parameter from the list in memory by its unique name. | |
| virtual bool | deleteParameterByNumber (const int idx)=0 |
| Remove a parameter from the list in memory by its index. | |
| virtual int | getNumberOfParameters () const =0 |
| Returns the number of parameters held. | |
| virtual std::string | getParameterSchemaType () const =0 |
| Obtain a symbolic name for the parameter element schema type. | |
| virtual std::string | getSchemaType () const =0 |
| Returns name of the schema type that can be used to validate this element. | |
| std::string | validateDeep (const ms_xml_schema *pSchemaFileObj) const |
| Performs validation of all child elements in addition to 'shallow' validation. | |
| std::string | validateShallow (const ms_xml_schema *pSchemaFileObj) const |
| Performs simple validation of the top-level elements only. | |
A class that represents a base parametersType.
The Mascot configuration files quantitation.xml and crosslinking.xml use a common node structure for a set of key-value pairs. ms_xml_parameters is a base class for ms_quant_parameters and ms_crosslinking_parameters, because the parameter sets share the same API.
Default constructor.
Assigns reasonable default values to all internal members.
| ms_xml_parameters | ( | const ms_xml_parameters & | src | ) |
Copying constructor.
| src | another instance of this class to copy the content from. |
| void defaultValues | ( | ) |
Call this member if you want to start again.
All internal values are reset to their defaults, as if the object had been freshly created with the default constructor.
|
pure virtual |
Remove a parameter from the list in memory by its unique name.
| name | name of the parameter for deletion. |
Implemented in ms_crosslinking_parameters, and ms_quant_parameters.
|
pure virtual |
Remove a parameter from the list in memory by its index.
| idx | number of the parameter for deletion from 0 to (getNumberOfParameters() - 1). |
Implemented in ms_crosslinking_parameters, and ms_quant_parameters.
|
pure virtual |
Returns the number of parameters held.
Implemented in ms_crosslinking_parameters, and ms_quant_parameters.
|
pure virtual |
Obtain a symbolic name for the parameter element schema type.
The obtained type name can be used to get a corresponding type description object from ms_xml_schema.
Implemented in ms_crosslinking_filters, ms_crosslinking_parameters, ms_crosslinking_scope, ms_crosslinking_settings, and ms_quant_parameters.
|
pure virtual |
Returns name of the schema type that can be used to validate this element.
Additional information about the current object can be retrieved from the associated XML schema file. Every element in an XML document is defined with a named type, which you can use to find out what kind of limits (numerical or otherwise) are defined for values of that type.
Implemented in ms_crosslinking_filters, ms_crosslinking_parameters, ms_crosslinking_scope, ms_crosslinking_settings, ms_quant_average, ms_quant_integration, ms_quant_multiplex, ms_quant_normalisation, ms_quant_outliers, ms_quant_parameters, ms_quant_precursor, ms_quant_quality, ms_quant_replicate, and ms_quant_reporter.
| std::string validateDeep | ( | const ms_xml_schema * | pSchemaFileObj | ) | const |
Performs validation of all child elements in addition to 'shallow' validation.
The current object can be checked against an XML schema. When using this method all possible checks are performed. However, this is not a substitute for the schema: some schema-defined constraint are not applied (unique fields, foreign keys etc.).
In order to make sure that current object is free from all syntax errors validate it as a part of the whole document.
| pSchemaFileObj | a valid schema object instance to validate against. |
| std::string validateShallow | ( | const ms_xml_schema * | pSchemaFileObj | ) | const |
Performs simple validation of the top-level elements only.
The current object can be checked against some basic constraints in a schema without looking at children element types. When using this method only the current object and children derived from standard types (for example, restrictions with enumerations) are checked. For more thorough validation, use validateDeep().
| pSchemaFileObj | a valid schema object instance to validate against. |
1.9.6