ms_quant_parameters Class Reference

A class that represents base parametersType in quantitation.xml. More...

#include <ms_quant_parameters.hpp>

Inheritance diagram for ms_quant_parameters:

Collaboration diagram for ms_quant_parameters:

Public Member Functions
	ms_quant_parameters ()
	Default constructor.
	ms_quant_parameters (const ms_quant_parameters &src)
	Copying constructor.
virtual	~ms_quant_parameters ()
	Destructor.
void	appendParameter (const ms_quant_parameter *item)
	Adds a new parameter at the end of the list.
virtual void	clearParameters ()
	Deletes all parameters from the list.
void	copyFrom (const ms_quant_parameters *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
virtual bool	deleteParameterByName (const char *name)
	Remove a parameter from the list in memory by its unique name.
virtual bool	deleteParameterByNumber (const int idx)
	Remove a parameter from the list in memory by its index.
virtual int	getNumberOfParameters () const
	Returns the number of parameters held.
const ms_quant_parameter *	getParameterByName (const char *name) const
	Returns a parameter object by its name or a null value in case of not found.
const ms_quant_parameter *	getParameterByNumber (const int idx) const
	Returns a parameter object by its number.
virtual std::string	getParameterSchemaType () const
	Obtain a symbolic name for the parameter element schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
ms_quant_parameters &	operator= (const ms_quant_parameters &right)
	C++ style assignment operator.
bool	updateParameterByName (const char *name, const ms_quant_parameter *param)
	Update the information for a specific parameter refering to it by its unique name.
bool	updateParameterByNumber (const int idx, const ms_quant_parameter *param)
	Update the information for a specific parameter refering to it by its index.
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

A class that represents base parametersType in quantitation.xml.

Holds a list of parameters.

Constructor & Destructor Documentation

ms_quant_parameters() [1/2]

ms_quant_parameters

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_parameters() [2/2]

ms_quant_parameters

(

const ms_quant_parameters &

src

)

Copying constructor.

Parameters

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

Member Function Documentation

appendParameter()

void appendParameter

(

const ms_quant_parameter *

item

)

Adds a new parameter at the end of the list.

Parameters

item	an instance of parameter object to copy content from.

copyFrom()

void copyFrom

(

const ms_quant_parameters *

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.

deleteParameterByName()

bool deleteParameterByName ( const char *  name )

virtual

Remove a parameter from the list in memory by its unique name.

Parameters

name	name of the parameter for deletion.

Returns

TRUE if the parameter has been found and successfully deleted and FALSE otherwise.

Implements ms_xml_parameters.

deleteParameterByNumber()

bool deleteParameterByNumber ( const int  idx )

virtual

Remove a parameter from the list in memory by its index.

Parameters

idx	number of the parameter for deletion from 0 to (getNumberOfParameters() - 1).

Returns

TRUE if the parameter has been found and successfully deleted and FALSE otherwise.

Implements ms_xml_parameters.

getNumberOfParameters()

int getNumberOfParameters ( ) const

virtual

Returns the number of parameters held.

Returns

total number of parameters in the list.

Implements ms_xml_parameters.

getParameterByName()

const ms_quant_parameter * getParameterByName

(

const char *

name

)

const

Returns a parameter object by its name or a null value in case of not found.

Parameters

name	name of the parameter to find.

Returns

a read-only pointer to a parameter object. See Maintaining object references: two rules of thumb.

getParameterByNumber()

const ms_quant_parameter * getParameterByNumber

(

const int

idx

)

const

Returns a parameter object by its number.

Parameters

idx	number of the parameter from 0 to (getNumberOfParameters() - 1).

Returns

a read-only pointer to a parameter object. See Maintaining object references: two rules of thumb.

getParameterSchemaType()

std::string getParameterSchemaType ( ) const

virtual

Obtain a symbolic name for the parameter element 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_parameters.

getSchemaType()

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

Reimplemented in ms_quant_average, ms_quant_integration, ms_quant_multiplex, ms_quant_normalisation, ms_quant_outliers, ms_quant_precursor, ms_quant_quality, ms_quant_replicate, and ms_quant_reporter.

operator=()

ms_quant_parameters & operator=

(

const ms_quant_parameters &

right

)

C++ style assignment operator.

Parameters

right

another instance of this class to copy the content from.

Returns

reference to the current object

updateParameterByName()

bool updateParameterByName	(	const char *	name,
		const ms_quant_parameter *	param
	)

Update the information for a specific parameter refering to it by its unique name.

Parameters

name	name of the parameter for updating.
param	an object to copy the content from.

Returns

TRUE if the parameter has been found and successfully updated and FALSE otherwise.

updateParameterByNumber()

bool updateParameterByNumber	(	const int	idx,
		const ms_quant_parameter *	param
	)

Update the information for a specific parameter refering to it by its index.

Parameters

idx	number of the parameter for updating from 0 to (getNumberOfParameters() - 1).
param	an object to copy the content from.

Returns

TRUE if the parameter has been found and successfully updated and FALSE otherwise.

validateDeep()

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

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

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

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_quant_parameters.hpp
• ms_quant_parameters.cpp