|
|
Accessions element in crosslinking.xml
More...
#include <ms_crosslinking_accessions.hpp>
Public Member Functions | |
| ms_crosslinking_accessions () | |
| Default constructor. | |
| ms_crosslinking_accessions (const ms_crosslinking_accessions &src) | |
| Copying constructor. | |
| virtual | ~ms_crosslinking_accessions () |
| Destructor. | |
| void | appendAccession (const ms_crosslinking_accession *item) |
| Adds a new accession code at the end of the list. | |
| void | clearAccessions () |
| Deletes all accession codes from the list. | |
| void | copyFrom (const ms_crosslinking_accessions *right) |
| Copies all content from another instance. | |
| void | defaultValues () |
| Call this member if you want to start again. | |
| bool | deleteAccessionByNumber (const int idx) |
| Remove a accession code from the list in memory by its index. | |
| const ms_crosslinking_accession * | getAccessionByNumber (const int idx) const |
| Returns a accession code object by its number. | |
| std::string | getAccessionSchemaType () const |
| Obtain a symbolic name for the accession element schema type. | |
| int | getNumberOfAccessions () const |
| Returns the number of accession. | |
| virtual std::string | getSchemaType () const |
| Returns name of the schema type that can be used to validate this element. | |
| ms_crosslinking_accessions & | operator= (const ms_crosslinking_accessions &right) |
| C++ style assignment operator. | |
| bool | updateAccessionByNumber (const int idx, const ms_crosslinking_accession *accession) |
| Update the information for a specific accession code refering to it by its index. | |
| 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. | |
Accessions element in crosslinking.xml
The list of accessions limits the search space of crosslinked peptides to just the named ones. If no accessions are defined, search space is unrestricted.
Default constructor.
Assigns reasonable default values to all internal members.
| ms_crosslinking_accessions | ( | const ms_crosslinking_accessions & | src ) |
Copying constructor.
| src | another instance of this class to copy the content from. |
| void appendAccession | ( | const ms_crosslinking_accession * | item ) |
Adds a new accession code at the end of the list.
Creates a new accession code object, copies all content from the object supplied as a parameter and adds it at the end of the methods list.
| item | an instance of a accession object to copy content from. |
| void copyFrom | ( | const ms_crosslinking_accessions * | 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 deleteAccessionByNumber | ( | const int | idx ) |
Remove a accession code from the list in memory by its index.
| idx | number of the accession code for deletion from 0 to (getNumberOfAccessions() - 1). |
| const ms_crosslinking_accession * getAccessionByNumber | ( | const int | idx ) | const |
Returns a accession code object by its number.
| idx | number of the accession code from 0 to (getNumberOfAccessions() - 1). |
| std::string getAccessionSchemaType | ( | ) | const |
Obtain a symbolic name for the accession element schema type.
The obtained type name can be used to get a corresponding type description object from ms_xml_schema.
| int getNumberOfAccessions | ( | ) | const |
Returns the number of accession.
| 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_crosslinking_accessions & operator= | ( | const ms_crosslinking_accessions & | right ) |
C++ style assignment operator.
| right | another instance of this class to copy the content from. |
| bool updateAccessionByNumber | ( | const int | idx, |
| const ms_crosslinking_accession * | accession | ||
| ) |
Update the information for a specific accession code refering to it by its index.
| idx | number of the accession code for updating from 0 to (getNumberOfAccessions() - 1). |
| accession | an object 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:31 |