ms_xml_parameter Class Reference

Parameter name and value pair. More...

#include <ms_xml_parameters.hpp>

Inheritance diagram for ms_xml_parameter:

Public Member Functions
	ms_xml_parameter ()
	Default constructor.
	ms_xml_parameter (const ms_xml_parameter &src)
	Copying constructor.
virtual	~ms_xml_parameter ()
	Destructor.
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 =0
	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 =0
	Obtain a symbolic name for the name attribute schema type.
virtual std::string	getSchemaType () const =0
	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 =0
	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_xml_parameter &	operator= (const ms_xml_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.

The Mascot configuration files quantitation.xml and crosslinking.xml use a common node structure for a set of key-value pairs. ms_xml_parameter is a base class for a single parameter element.

Constructor & Destructor Documentation

ms_xml_parameter() [1/2]

ms_xml_parameter

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_xml_parameter() [2/2]

ms_xml_parameter

(

const ms_xml_parameter &

src

)

Copying constructor.

Parameters

src	another instance of this class to copy the content from.

Member Function Documentation

copyFrom()

void copyFrom

(

const ms_xml_parameter *

right

)

Copies all content from another instance.

Parameters

right

another instance of this class to copy the content from.

defaultValues()

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.

dropDescription()

void dropDescription

(

)

Delete the description attribute.

Deletes the attribute until is re-set.

dropName()

void dropName

(

)

Delete the name attribute.

Deletes the attribute until is re-set.

getDescription()

std::string getDescription

(

)

const

Returns the value of the description attribute.

Returns

a free text description of this parameter.

getDescriptionSchemaType()

std::string getDescriptionSchemaType ( ) const

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

Implemented in ms_crosslinking_parameter, and ms_quant_parameter.

getName()

std::string getName

(

)

const

Returns the value of the name attribute.

Returns

a descriptive name that will appear in drop down lists, etc.

getNameSchemaType()

std::string getNameSchemaType ( ) const

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

Implemented in ms_crosslinking_parameter, and ms_quant_parameter.

getSchemaType()

std::string getSchemaType ( ) const

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

Implemented in ms_crosslinking_parameter, and ms_quant_parameter.

getValue()

std::string getValue

(

)

const

Returns the value of the value attribute.

Returns

a string value of this parameter.

getValueSchemaType()

std::string getValueSchemaType ( ) const

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

Implemented in ms_crosslinking_parameter, and ms_quant_parameter.

haveDescription()

bool haveDescription

(

)

const

Indicates presence of the description attribute.

Returns

TRUE if the attribute is present and FALSE otherwise.

haveName()

bool haveName

(

)

const

Indicates presence of the name attribute.

Returns

TRUE if the attribute is present and FALSE otherwise.

operator=()

ms_xml_parameter & operator=

(

const ms_xml_parameter &

right

)

C++ style assignment operator.

Parameters

right

another instance of this class to copy the content from.

Returns

reference to the current object

setDescription()

void setDescription

(

const char *

value

)

Set a custom value for the description attribute.

Parameters

value

a new value for the attribute.

setName()

void setName

(

const char *

value

)

Set a custom value for the name attribute.

Parameters

value

a new value for the attribute.

setValue()

void setValue

(

const char *

value

)

Set a custom value for the value attribute.

Parameters

value

a new string value for the parameter.

validateDeep()

std::string validateDeep

(

const ms_xml_schema *

pSchemaFileObj

)

const

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

pSchemaFileObj

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

validateShallow()

std::string validateShallow

(

const ms_xml_schema *

pSchemaFileObj

)

const

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

pSchemaFileObj

a 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:

• ms_xml_parameters.hpp
• ms_xml_parameters.cpp