Matrix Science header
Public Member Functions

ms_quant_numerator Class Reference
[Mascot configuration files module]

Represent numerator_component and denominator_component elements. More...

#include <ms_quant_numerator.hpp>

List of all members.

Public Member Functions

 ms_quant_numerator ()
 Default constructor.
 ms_quant_numerator (const ms_quant_numerator &src)
 Copying constructor.
virtual ~ms_quant_numerator ()
 Destructor.
void copyFrom (const ms_quant_numerator *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropCoefficient ()
 Delete the coefficient attribute.
void dropName ()
 Delete the name attribute.
std::string getCoefficient () const
 Returns the value of the coefficient attribute.
std::string getCoefficientSchemaType () const
 Obtain a symbolic name for the coefficient attribute schema type.
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 getName () const
 Returns the value of the name attribute.
std::string getNameSchemaType () const
 Obtain a symbolic name for the name attribute schema type.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
bool haveCoefficient () const
 Indicates presence of the coefficient attribute.
bool haveName () const
 Indicates presence of the name attribute.
ms_quant_numeratoroperator= (const ms_quant_numerator &right)
 C++ style assignment operator.
void setCoefficient (const char *value)
 Set a custom value for the coefficient attribute.
void setContent (const char *value)
 Set a custom value for the the element.
void setName (const char *value)
 Set a custom value for the name 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

Represent numerator_component and denominator_component 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 copyFrom ( const ms_quant_numerator 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 dropCoefficient (  )

Delete the coefficient attribute.

Deletes the attribute until is re-set.

void dropName (  )

Delete the name attribute.

Deletes the attribute until is re-set.

std::string getCoefficient (  ) const

Returns the value of the coefficient attribute.

Returns:
coefficient used to form linear combination of values.
std::string getCoefficientSchemaType (  ) const

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

Obtain a symbolic name for the 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 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").
bool haveCoefficient (  ) const

Indicates presence of the coefficient attribute.

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

Indicates presence of the name attribute.

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

C++ style assignment operator.

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

Set a custom value for the coefficient attribute.

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

Set a custom value for the the element.

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

Set a custom value for the name 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