Matrix Science header
Public Member Functions

ms_quant_element Class Reference
[Mascot configuration files module]

The element sub-element of compositionType in quantitation.xml. More...

#include <ms_quant_composition.hpp>

List of all members.

Public Member Functions

 ms_quant_element ()
 Default constructor.
 ms_quant_element (const ms_quant_element &src)
 Copying constructor.
virtual ~ms_quant_element ()
 Destructor.
void copyFrom (const ms_quant_element *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropNumber ()
 Deletes the number attribute.
void dropSymbol ()
 Deletes the symbol attribute.
int getNumber () const
 Returns the value of the number attribute.
std::string getNumberSchemaType () const
 Obtain a symbolic name for the number attribute schema type.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
std::string getSymbol () const
 Returns the value of the symbol attribute.
std::string getSymbolSchemaType () const
 Obtain a symbolic name for the symbol attribute schema type.
bool haveNumber () const
 Indicates presence of the number attribute.
bool haveSymbol () const
 Indicates presence of the symbol attribute.
ms_quant_elementoperator= (const ms_quant_element &right)
 C++ style assignment operator.
void setNumber (const int number)
 Set a custom value for the number attribute.
void setSymbol (const char *symbol)
 Set a custom value for the symbol attribute.
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

The element sub-element of compositionType in quantitation.xml.


Constructor & Destructor Documentation

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_element ( const ms_quant_element src )

Copying constructor.

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

Member Function Documentation

void copyFrom ( const ms_quant_element 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.

void dropNumber (  )

Deletes the number attribute.

Deletes the attribute until is re-set.

void dropSymbol (  )

Deletes the symbol attribute.

Deletes the attribute until is re-set.

int getNumber (  ) const

Returns the value of the number attribute.

Count for the element or isotope. Can be negative.

Returns:
current value of the attribute.
std::string getNumberSchemaType (  ) const

Obtain a symbolic name for the number attribute 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.
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").
std::string getSymbol (  ) const

Returns the value of the symbol attribute.

Chemical element or isotope.

Returns:
current value of the attribute.
std::string getSymbolSchemaType (  ) const

Obtain a symbolic name for the symbol attribute 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.
bool haveNumber (  ) const

Indicates presence of the number attribute.

Returns:
TRUE if the attribute is present and FALSE otherwise.
bool haveSymbol (  ) const

Indicates presence of the symbol attribute.

Returns:
TRUE if the attribute is present and FALSE otherwise.
ms_quant_element & operator= ( const ms_quant_element right )

C++ style assignment operator.

Parameters:
rightanother instance of this class to copy the content from.
Returns:
reference to the current object
void setNumber ( const int  number )

Set a custom value for the number attribute.

Parameters:
numbera new value for the attribute.
void setSymbol ( const char *  symbol )

Set a custom value for the symbol attribute.

Parameters:
symbola new value for the attribute.
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.
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.

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