An object of this class represent a collection of peptide elements in quantitation.xml
.
More...
#include <ms_quant_normalisation_peptide.hpp>
Public Member Functions | |
ms_quant_normalisation_peptides () | |
Default constructor. | |
ms_quant_normalisation_peptides (const ms_quant_normalisation_peptides &src) | |
Copying constructor. | |
virtual | ~ms_quant_normalisation_peptides () |
Destructor. | |
void | appendPeptide (const ms_quant_normalisation_peptide *pep) |
Adds a new peptide element at the end of the list. | |
void | clearPeptides () |
Deletes all peptide elements from the list. | |
void | copyFrom (const ms_quant_normalisation_peptides *right) |
Copies all content from another instance. | |
void | defaultValues () |
Call this member if you want to start again. | |
bool | deletePeptide (const int idx) |
Removes peptide element from the list. | |
int | getNumberOfPeptides () const |
Returns the number of nested peptide elements. | |
const ms_quant_normalisation_peptide * | getPeptide (const int idx) const |
Returns the value of the peptide element object by its number. | |
std::string | getPeptideSchemaType () const |
Obtain a symbolic name for the peptide element schema type. | |
virtual std::string | getSchemaType () const |
Returns name of the schema type that can be used to validate this element. | |
ms_quant_normalisation_peptides & | operator= (const ms_quant_normalisation_peptides &right) |
C++ style assignment operator. | |
bool | updatePeptide (const int idx, const ms_quant_normalisation_peptide *pep) |
Supply new content for one of the peptide elements in the list. | |
virtual std::string | validateDeep (const ms_xml_schema *pSchemaFileObj) const |
Performs validation of all child elements in addition to 'shallow' validation. | |
virtual std::string | validateShallow (const ms_xml_schema *pSchemaFileObj) const |
Performs simple validation of the top-level elements only. |
An object of this class represent a collection of peptide elements in quantitation.xml
.
Default constructor.
Assigns reasonable default values to all internal members.
ms_quant_normalisation_peptides | ( | const ms_quant_normalisation_peptides & | src ) |
Copying constructor.
src | another instance of this class to copy the content from. |
void appendPeptide | ( | const ms_quant_normalisation_peptide * | pep ) |
Adds a new peptide
element at the end of the list.
pep | a new element to be added to the list. |
void copyFrom | ( | const ms_quant_normalisation_peptides * | right ) |
Copies all content from another instance.
right | 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.
bool deletePeptide | ( | const int | idx ) |
Removes peptide
element from the list.
idx | a zero based index of the peptide element to delete from the list. |
int getNumberOfPeptides | ( | ) | const |
Returns the number of nested peptide
elements.
peptide
elements. const ms_quant_normalisation_peptide * getPeptide | ( | const int | idx ) | const |
Returns the value of the peptide
element object by its number.
idx | a zero based index of the element to retrieve. |
std::string getPeptideSchemaType | ( | ) | const |
Obtain a symbolic name for the peptide
element schema type.
The obtained type name can be used to get a corresponding type description object from ms_xml_schema.
std::string getSchemaType | ( | ) | const [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.
ms_quant_normalisation_peptides & operator= | ( | const ms_quant_normalisation_peptides & | right ) |
C++ style assignment operator.
right | another instance of this class to copy the content from. |
bool updatePeptide | ( | const int | idx, |
const ms_quant_normalisation_peptide * | pep | ||
) |
Supply new content for one of the peptide
elements in the list.
idx | a zero based index of the element to update. |
pep | a source to copy the content from. |
std::string validateDeep | ( | const ms_xml_schema * | pSchemaFileObj ) | const [virtual] |
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 [virtual] |
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. |
Copyright © 2022 Matrix Science Ltd. All Rights Reserved. Generated on Thu Mar 31 2022 01:12:37 |