ms_quant_normalisation_proteins Class Reference [Mascot configuration files module]

An object of this class represent a collection of peptide elements in quantitation.xml. More...

#include <ms_quant_normalisation_protein.hpp>

List of all members.

Public Member Functions
	ms_quant_normalisation_proteins ()
	Default constructor.
	ms_quant_normalisation_proteins (const ms_quant_normalisation_proteins &src)
	Copying constructor.
virtual	~ms_quant_normalisation_proteins ()
	Destructor.
void	appendProtein (const ms_quant_normalisation_protein *protein)
	Adds a new protein element at the end of the list.
void	clearProteins ()
	Deletes all protein elements from the list.
void	copyFrom (const ms_quant_normalisation_proteins *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
bool	deleteProtein (const int idx)
	Removes a protein element from the list.
int	getNumberOfProteins () const
	Returns a number of nested protein elements.
const ms_quant_normalisation_protein *	getProtein (const int idx) const
	Returns the value of the protein element object by its number.
std::string	getProteinSchemaType () const
	Obtain a symbolic name for the protein element schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
ms_quant_normalisation_proteins &	operator= (const ms_quant_normalisation_proteins &right)
	C++ style assignment operator.
bool	updateProtein (const int idx, const ms_quant_normalisation_protein *protein)
	Supply new content for one of the protein elements in the list.
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

An object of this class represent a collection of peptide elements in quantitation.xml.

---

Constructor & Destructor Documentation

ms_quant_normalisation_proteins

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_normalisation_proteins

(

const ms_quant_normalisation_proteins &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void appendProtein

(

const ms_quant_normalisation_protein *

protein )

Adds a new protein element at the end of the list.

Parameters:

protein

a new element to be added to the list.

void copyFrom

(

const ms_quant_normalisation_proteins *

right )

Copies all content from another instance.

Parameters:

right

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

bool deleteProtein

(

const int

idx )

Removes a protein element from the list.

Parameters:

idx	a zero based index of the protein element to delete from the list.

Returns:

true if the index is in range, false otherwise

int getNumberOfProteins

(

)

const

Returns a number of nested protein elements.

Returns:

total number of nested protein elements.

const ms_quant_normalisation_protein * getProtein

(

const int

idx )

const

Returns the value of the protein element object by its number.

Parameters:

idx	a zero based index of the element to retrieve.

Returns:

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

std::string getProteinSchemaType

(

)

const

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

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, "umod:nameType")

ms_quant_normalisation_proteins & operator=

(

const ms_quant_normalisation_proteins &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

bool updateProtein	(	const int	idx,
		const ms_quant_normalisation_protein *	protein
	)

Supply new content for one of the protein elements in the list.

Parameters:

idx	a zero based index of the element to update.
protein	a source to copy the content from.

Returns:

TRUE if the element has been successfully updated.

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:

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.

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:

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_normalisation_protein.hpp
• ms_quant_normalisation_protein.cpp