ms_quant_pepneutralloss Class Reference [Mascot configuration files module]

A neutral loss from the precursor. More...

#include <ms_quant_pepneutralloss.hpp>

Inheritance diagram for ms_quant_pepneutralloss:

Collaboration diagram for ms_quant_pepneutralloss:

List of all members.

Public Member Functions
	ms_quant_pepneutralloss ()
	Default constructor.
	ms_quant_pepneutralloss (const ms_quant_pepneutralloss &src)
	Copying constructor.
virtual	~ms_quant_pepneutralloss ()
	Destructor.
void	appendElement (const ms_quant_element *element)
	Adds a new element at the end of the list.
void	clearElements ()
	Deletes all elements from the list.
void	copyFrom (const ms_quant_pepneutralloss *right)
	Copies all content from another instance.
void	copyFrom (const ms_quant_composition *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
bool	deleteElement (const int idx)
	Remove an element from the list.
void	dropRequired ()
	Deletes the required attribute.
const ms_quant_element *	getElement (const int idx) const
	Returns an element object by its number.
std::string	getElementSchemaType () const
	Obtain a symbolic name for the element's schema type.
int	getNumberOfElements () const
	Returns a number of elements held.
std::string	getRequiredSchemaType () const
	Obtain a symbolic name for the required attribute schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
bool	haveRequired () const
	Indicates presence of the required attribute.
bool	isRequired () const
	Returns the value of the required attribute.
ms_quant_pepneutralloss &	operator= (const ms_quant_pepneutralloss &right)
	C++ style assignment operator.
void	setRequired (const bool required)
	Set a custom value for the required attribute.
bool	updateElement (const int idx, const ms_quant_element *element)
	Update the information for a specific element.
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

A neutral loss from the precursor.

---

Constructor & Destructor Documentation

ms_quant_pepneutralloss

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_pepneutralloss

(

const ms_quant_pepneutralloss &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void appendElement

(

const ms_quant_element *

element )

[inherited]

Adds a new element at the end of the list.

Parameters:

element

an instance of element object to copy content from.

void copyFrom

(

const ms_quant_pepneutralloss *

right )

Copies all content from another instance.

Parameters:

right

another instance of this class to copy the content from.

void copyFrom

(

const ms_quant_composition *

right )

[inherited]

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.

Reimplemented from ms_quant_composition.

bool deleteElement

(

const int

idx )

[inherited]

Remove an element from the list.

Parameters:

idx	number of the element for deletion from 0 to (getNumberOfElements() - 1).

Returns:

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

void dropRequired

(

)

Deletes the required attribute.

Deletes the attribute until is re-set.

const ms_quant_element * getElement

(

const int

idx )

const [inherited]

Returns an element object by its number.

Parameters:

idx	number of the element from 0 to (getNumberOfElements() - 1).

Returns:

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

std::string getElementSchemaType

(

)

const [inherited]

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

int getNumberOfElements

(

)

const [inherited]

Returns a number of elements held.

Returns:

total number of elements in the list.

std::string getRequiredSchemaType

(

)

const

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

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

Reimplemented from ms_quant_composition.

bool haveRequired

(

)

const

Indicates presence of the required attribute.

Returns:

TRUE if the attribute is present and FALSE otherwise.

bool isRequired

(

)

const

Returns the value of the required attribute.

TRUE if this is a required neutral loss.

Returns:

current value of the attribute.

ms_quant_pepneutralloss & operator=

(

const ms_quant_pepneutralloss &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

void setRequired

(

const bool

required )

Set a custom value for the required attribute.

Parameters:

required

a new value for the attribute.

bool updateElement	(	const int	idx,
		const ms_quant_element *	element
	)		[inherited]

Update the information for a specific element.

Parameters:

idx	number of the element for updating from 0 to (getNumberOfElements() - 1).
element	an object to copy the content from.

Returns:

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

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.

Reimplemented from ms_quant_composition.

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.

Reimplemented from ms_quant_composition.

---

The documentation for this class was generated from the following files:

• ms_quant_pepneutralloss.hpp
• ms_quant_pepneutralloss.cpp