Matrix Science header
Public Member Functions

ms_umod_element Class Reference
[Mascot configuration files module]

Represents an element object in unimod.xml. More...

#include <ms_umod_element.hpp>

List of all members.

Public Member Functions

 ms_umod_element ()
 Default constructor.
 ms_umod_element (const ms_umod_element &src)
 Copying constructor.
virtual ~ms_umod_element ()
 Destructor.
void copyFrom (const ms_umod_element *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropAvgeMass ()
 Delete the avge_mass attribute.
void dropFullName ()
 Delete the full_name attribute.
void dropMonoMass ()
 Delete the mono_mass attribute.
void dropTitle ()
 Delete the title attribute.
std::string getAvgeMass () const
 Returns the value of the avge_mass attribute as a string.
double getAvgeMassAsNumber () const
 Returns the value of the avge_mass attribute as a floating point number.
std::string getAvgeMassSchemaType () const
 Obtain a symbolic name for the avge_mass attribute schema type.
std::string getFullName () const
 Returns the value of the full_name attribute.
std::string getFullNameSchemaType () const
 Obtain a symbolic name for the full_name attribute schema type.
std::string getMonoMass () const
 Returns the value of the mono_mass attribute as a string.
double getMonoMassAsNumber () const
 Returns the value of the mono_mass attribute as a floating point number.
std::string getMonoMassSchemaType () const
 Obtain a symbolic name for the mono_mass attribute schema type.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
std::string getTitle () const
 Returns the value of the title attribute.
std::string getTitleSchemaType () const
 Obtain a symbolic name for the title attribute schema type.
bool haveAvgeMass () const
 Indicates presence of the avge_mass attribute.
bool haveFullName () const
 Indicates presence of the full_name attribute.
bool haveMonoMass () const
 Indicates presence of the mono_mass attribute.
bool haveTitle () const
 Indicates presence of the title attribute.
ms_umod_elementoperator= (const ms_umod_element &right)
 C++ style assignment operator.
bool setAvgeMass (const char *value, ms_errs *err=NULL)
 Set a custom string value for the avge_mass attribute.
void setFullName (const char *value)
 Set a custom value for the full_name attribute.
bool setMonoMass (const char *value, ms_errs *err=NULL)
 Set a custom string value for the mono_mass attribute.
void setTitle (const char *value)
 Set a custom value for the title 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

Represents an element object in unimod.xml.


Constructor & Destructor Documentation

Default constructor.

Assigns reasonable default values to all internal members.

ms_umod_element ( const ms_umod_element src )

Copying constructor.

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

Member Function Documentation

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

After calling this method, internal values are reset to defaults, as if the object had been freshly created with the default constructor.

void dropAvgeMass (  )

Delete the avge_mass attribute.

Deletes the attribute until is re-set.

void dropFullName (  )

Delete the full_name attribute.

Deletes the attribute until is re-set.

void dropMonoMass (  )

Delete the mono_mass attribute.

Deletes the attribute until is re-set.

void dropTitle (  )

Delete the title attribute.

Deletes the attribute until is re-set.

std::string getAvgeMass (  ) const

Returns the value of the avge_mass attribute as a string.

Average mass for the chemical element or an isotope.

Returns:
current string value of the attribute.
double getAvgeMassAsNumber (  ) const

Returns the value of the avge_mass attribute as a floating point number.

Average mass for the chemical element or an isotope.

Returns:
current floating point number value of the attribute.
std::string getAvgeMassSchemaType (  ) const

Obtain a symbolic name for the avge_mass 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 getFullName (  ) const

Returns the value of the full_name attribute.

A full name for the chemical element or an isotope (for example, 'Hydrogen').

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

Obtain a symbolic name for the full_name 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 getMonoMass (  ) const

Returns the value of the mono_mass attribute as a string.

Monoisotopic mass for the chemical element or an isotope.

Returns:
current string value of the attribute.
double getMonoMassAsNumber (  ) const

Returns the value of the mono_mass attribute as a floating point number.

Monoisotopic mass for the chemical element or an isotope.

Returns:
current floating point number value of the attribute.
std::string getMonoMassSchemaType (  ) const

Obtain a symbolic name for the mono_mass 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, "umod:nameType").
std::string getTitle (  ) const

Returns the value of the title attribute.

A unique name for the chemical element or an isotope (for example, 'N15').

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

Obtain a symbolic name for the title 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 haveAvgeMass (  ) const

Indicates presence of the avge_mass attribute.

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

Indicates presence of the full_name attribute.

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

Indicates presence of the mono_mass attribute.

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

Indicates presence of the title attribute.

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

C++ style assignment operator.

Parameters:
rightanother instance of this class to copy the content from.
Returns:
reference to the current object
bool setAvgeMass ( const char *  value,
ms_errs err = NULL 
)

Set a custom string value for the avge_mass attribute.

The method is trying to parse the string value as a floating point number first. It it fails it reports an error and returns FALSE leaving the old value unchanged.

Parameters:
valuea new string value for the attribute.
erran error object to return possible error messages.
Returns:
TRUE if the value has been parsed successfully and FALSE otherwise.
void setFullName ( const char *  value )

Set a custom value for the full_name attribute.

Parameters:
valuea new value for the attribute.
bool setMonoMass ( const char *  value,
ms_errs err = NULL 
)

Set a custom string value for the mono_mass attribute.

The method is trying to parse the string value as a floating point number first. It it fails it reports an error and returns FALSE leaving the old value unchanged.

Parameters:
valuea new string value for the attribute.
erran error object to return possible error messages.
Returns:
TRUE if the value has been parsed successfully and FALSE otherwise.
void setTitle ( const char *  value )

Set a custom value for the title attribute.

Parameters:
valuea 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:55