Matrix Science header
Public Member Functions

ms_quant_composition Class Reference
[Mascot configuration files module]

Describes the compositionType type in quantitation.xml. More...

#include <ms_quant_composition.hpp>

Inheritance diagram for ms_quant_composition:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ms_quant_composition ()
 Default constructor.
 ms_quant_composition (const ms_quant_composition &src)
 Copying constructor.
virtual ~ms_quant_composition ()
 Destructor.
void appendElement (const ms_quant_element *element)
 Adds a new element at the end of the list.
void clearElements ()
 Deletes all elements from the list.
void copyFrom (const ms_quant_composition *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
bool deleteElement (const int idx)
 Remove an element from the list.
const ms_quant_elementgetElement (const int idx) const
 Returns an element object by its number.
std::string getElementSchemaType () const
 Obtain a symbolic name for the element's schema type.
int getNumberOfElements () const
 Returns a number of elements held.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
ms_quant_compositionoperator= (const ms_quant_composition &right)
 C++ style assignment operator.
bool updateElement (const int idx, const ms_quant_element *element)
 Update the information for a specific element.
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.

Detailed Description

Describes the compositionType type in quantitation.xml.

Objects of this type host a list of nested element elements.


Constructor & Destructor Documentation

Default constructor.

Assigns reasonable default values to all internal members.

Copying constructor.

Parameters:
srcanother instance of this class to copy the content from.

Member Function Documentation

void appendElement ( const ms_quant_element element )

Adds a new element at the end of the list.

Parameters:
elementan instance of element object to copy content from.
void copyFrom ( const ms_quant_composition right )

Copies all content from another instance.

Parameters:
rightanother 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.

Reimplemented in ms_quant_neutralloss, and ms_quant_pepneutralloss.

bool deleteElement ( const int  idx )

Remove an element from the list.

Parameters:
idxnumber of the element for deletion from 0 to (getNumberOfElements() - 1).
Returns:
TRUE if the element has been found and successfully deleted and FALSE otherwise.
const ms_quant_element * getElement ( const int  idx ) const

Returns an element object by its number.

Parameters:
idxnumber of the element from 0 to (getNumberOfElements() - 1).
Returns:
a read-only pointer to an element object. See Maintaining object references: two rules of thumb.
std::string getElementSchemaType (  ) const

Obtain a symbolic name for the element's schema type.

The obtained type name can be used to get a corresponding type description object from ms_xml_schema.

Returns:
symbolic type name for the element.
int getNumberOfElements (  ) const

Returns a number of elements held.

Returns:
total number of elements in the list.
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.

See also:
validateShallow(), validateDeep()
Returns:
a symbolic fully qualified type name (for example, "mqm:nameType").

Reimplemented in ms_quant_neutralloss, and ms_quant_pepneutralloss.

ms_quant_composition & operator= ( const ms_quant_composition right )

C++ style assignment operator.

Parameters:
rightanother instance of this class to copy the content from.
Returns:
reference to the current object
bool updateElement ( const int  idx,
const ms_quant_element element 
)

Update the information for a specific element.

Parameters:
idxnumber of the element for updating from 0 to (getNumberOfElements() - 1).
elementan object to copy the content from.
Returns:
TRUE if the element has been found and successfully updated and FALSE otherwise.
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.

See also:
validateShallow(), getSchemaType()
Parameters:
pSchemaFileObja valid schema object instance to validate against.
Returns:
user-friendly description of any errors found during validation or an empty string if no errors detected.

Reimplemented in ms_quant_neutralloss, and ms_quant_pepneutralloss.

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().

See also:
getSchemaType()
Parameters:
pSchemaFileObja valid schema object instance to validate against.
Returns:
user-friendly description of any errors found during validation or an empty string if no errors detected.

Reimplemented in ms_quant_neutralloss, and ms_quant_pepneutralloss.


The documentation for this class was generated from the following files:
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:54