Matrix Science header
Public Member Functions

ms_quant_parameter Class Reference
[Mascot configuration files module]

Parameter name and value pair. More...

#include <ms_quant_parameters.hpp>

Inheritance diagram for ms_quant_parameter:
Inheritance graph
[legend]
Collaboration diagram for ms_quant_parameter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ms_quant_parameter ()
 Default constructor.
 ms_quant_parameter (const ms_quant_parameter &src)
 Copying constructor.
virtual ~ms_quant_parameter ()
 Destructor.
void copyFrom (const ms_quant_parameter *right)
 Copies all content from another instance.
void copyFrom (const ms_xml_parameter *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropDescription ()
 Delete the description attribute.
void dropName ()
 Delete the name attribute.
std::string getDescription () const
 Returns the value of the description attribute.
virtual std::string getDescriptionSchemaType () const
 Obtain a symbolic name for the description attribute schema type.
std::string getName () const
 Returns the value of the name attribute.
virtual 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.
std::string getValue () const
 Returns the value of the value attribute.
virtual std::string getValueSchemaType () const
 Obtain a symbolic name for the value attribute schema type.
bool haveDescription () const
 Indicates presence of the description attribute.
bool haveName () const
 Indicates presence of the name attribute.
ms_quant_parameteroperator= (const ms_quant_parameter &right)
 C++ style assignment operator.
void setDescription (const char *value)
 Set a custom value for the description attribute.
void setName (const char *value)
 Set a custom value for the name attribute.
void setValue (const char *value)
 Set a custom value for the value attribute.
std::string validateDeep (const ms_xml_schema *pSchemaFileObj) const
 Performs validation of all child elements in addition to 'shallow' validation.
std::string validateShallow (const ms_xml_schema *pSchemaFileObj) const
 Performs simple validation of the top-level elements only.

Detailed Description

Parameter name and value pair.


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_parameter right )

Copies all content from another instance.

Parameters:
rightanother instance of this class to copy the content from.
void copyFrom ( const ms_xml_parameter right ) [inherited]

Copies all content from another instance.

Parameters:
rightanother instance of this class to copy the content from.
void defaultValues (  ) [inherited]

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_crosslinking_parameter.

void dropDescription (  ) [inherited]

Delete the description attribute.

Deletes the attribute until is re-set.

void dropName (  ) [inherited]

Delete the name attribute.

Deletes the attribute until is re-set.

std::string getDescription (  ) const [inherited]

Returns the value of the description attribute.

Returns:
a free text description of this parameter.
std::string getDescriptionSchemaType (  ) const [virtual]

Obtain a symbolic name for the description 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.

Implements ms_xml_parameter.

std::string getName (  ) const [inherited]

Returns the value of the name attribute.

Returns:
a descriptive name that will appear in drop down lists, etc.
std::string getNameSchemaType (  ) const [virtual]

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.

Implements ms_xml_parameter.

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

Implements ms_xml_parameter.

std::string getValue (  ) const [inherited]

Returns the value of the value attribute.

Returns:
a string value of this parameter.
std::string getValueSchemaType (  ) const [virtual]

Obtain a symbolic name for the value 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.

Implements ms_xml_parameter.

bool haveDescription (  ) const [inherited]

Indicates presence of the description attribute.

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

Indicates presence of the name attribute.

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

C++ style assignment operator.

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

Set a custom value for the description attribute.

Parameters:
valuea new value for the attribute.
void setName ( const char *  value ) [inherited]

Set a custom value for the name attribute.

Parameters:
valuea new value for the attribute.
void setValue ( const char *  value ) [inherited]

Set a custom value for the value attribute.

Parameters:
valuea new string value for the parameter.
std::string validateDeep ( const ms_xml_schema *  pSchemaFileObj ) const [inherited]

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 [inherited]

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 © 2022 Matrix Science Ltd.  All Rights Reserved. Generated on Thu Mar 31 2022 01:12:37