ms_quant_normalisation_peptide Class Reference [Mascot configuration files module]

An object of this class represent a single peptide element in quantitation.xml. More...

#include <ms_quant_normalisation_peptide.hpp>

List of all members.

Public Member Functions
	ms_quant_normalisation_peptide ()
	Default constructor.
	ms_quant_normalisation_peptide (const ms_quant_normalisation_peptide &src)
	Copying constructor.
virtual	~ms_quant_normalisation_peptide ()
	Destructor.
void	copyFrom (const ms_quant_normalisation_peptide *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
void	dropSequence ()
	Delete the sequence attribute.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
std::string	getSequence () const
	Returns the value of the sequence attribute.
std::string	getSequenceSchemaType () const
	Obtain a symbolic name for the sequence attribute schema type.
bool	haveSequence () const
	Check for presence of the sequence attribute.
ms_quant_normalisation_peptide &	operator= (const ms_quant_normalisation_peptide &right)
	C++ style assignment operator.
void	setSequence (const char *value)
	Supply custom content for sequence 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

An object of this class represent a single peptide element in quantitation.xml.

Identifies a peptide sequence to be used for normalisation.

---

Constructor & Destructor Documentation

ms_quant_normalisation_peptide

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_normalisation_peptide

(

const ms_quant_normalisation_peptide &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void copyFrom

(

const ms_quant_normalisation_peptide *

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.

void dropSequence

(

)

Delete the sequence attribute.

Deletes the attribute until it is re-set.

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

std::string getSequence

(

)

const

Returns the value of the sequence attribute.

Returns:

peptide sequence string.

std::string getSequenceSchemaType

(

)

const

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

bool haveSequence

(

)

const

Check for presence of the sequence attribute.

Returns:

TRUE if the attribute is present and FALSE otherwise.

ms_quant_normalisation_peptide & operator=

(

const ms_quant_normalisation_peptide &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

void setSequence

(

const char *

value )

Supply custom content for sequence attribute.

Parameters:

value

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

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_peptide.hpp
• ms_quant_normalisation_peptide.cpp