Matrix Science header
Public Member Functions

ms_quant_correction Class Reference
[Mascot configuration files module]

Represents a correction element. More...

#include <ms_quant_correction.hpp>

List of all members.

Public Member Functions

 ms_quant_correction ()
 Default constructor.
 ms_quant_correction (const ms_quant_correction &src)
 Copying constructor.
virtual ~ms_quant_correction ()
 Destructor.
void copyFrom (const ms_quant_correction *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropElement ()
 Delete the element attribute.
void dropShift ()
 Delete the shift attribute.
void dropType ()
 Delete the type attribute.
std::string getContent () const
 Returns string value of the element.
std::string getContentSchemaType () const
 Obtain a symbolic name for the element's schema type.
std::string getElement () const
 Returns the value of the element attribute.
std::string getElementSchemaType () const
 Obtain a symbolic name for the the element attribute schema type.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
int getShift () const
 Returns the value of the shift attribute.
std::string getShiftSchemaType () const
 Obtain a symbolic name for the shift attribute schema type.
std::string getType () const
 Returns the value of the type attribute.
std::string getTypeSchemaType () const
 Obtain a symbolic name for the type attribute schema type.
bool haveElement () const
 Indicates presence of the element attribute.
bool haveShift () const
 Indicates presence of the shift attribute.
bool haveType () const
 Indicates presence of the type attribute.
ms_quant_correctionoperator= (const ms_quant_correction &right)
 C++ style assignment operator.
void setContent (const char *value)
 Set a custom floating point number value as a string for the element content.
void setElement (const char *value)
 Set a custom value for the element attribute.
void setShift (const int value)
 Set a custom value for the shift attribute.
void setType (const char *value)
 Set a custom value for the type 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 a correction element.


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 copyFrom ( const ms_quant_correction 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 dropElement (  )

Delete the element attribute.

Deletes the attribute until is re-set.

void dropShift (  )

Delete the shift attribute.

Deletes the attribute until is re-set.

void dropType (  )

Delete the type attribute.

Deletes the attribute until is re-set.

std::string getContent (  ) const

Returns string value of the element.

Returns:
string value of the element content.
std::string getContentSchemaType (  ) 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.
std::string getElement (  ) const

Returns the value of the element attribute.

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

Obtain a symbolic name for the the element 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").
int getShift (  ) const

Returns the value of the shift attribute.

Returns:
for example, -1.
std::string getShiftSchemaType (  ) const

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

Returns the value of the type attribute.

Returns:
AB factor or linear combination coefficient.
std::string getTypeSchemaType (  ) const

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

Indicates presence of the element attribute.

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

Indicates presence of the shift attribute.

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

Indicates presence of the type attribute.

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

C++ style assignment operator.

Parameters:
rightanother instance of this class to copy the content from.
Returns:
reference to the current object
void setContent ( const char *  value )

Set a custom floating point number value as a string for the element content.

Parameters:
valuea new value for the content.
void setElement ( const char *  value )

Set a custom value for the element attribute.

Parameters:
valuea new value for the attribute.
void setShift ( const int  value )

Set a custom value for the shift attribute.

Parameters:
valuea new value for the attribute.
void setType ( const char *  value )

Set a custom value for the type 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:54