ms_quant_satellite Class Reference [Mascot configuration files module]

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

#include <ms_quant_satellite.hpp>

Collaboration diagram for ms_quant_satellite:

List of all members.

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

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

Modification group that defines satellite peaks to be summed into the heaviest component to correct for Arg-Pro conversion of SILAC label.

---

Constructor & Destructor Documentation

ms_quant_satellite

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_satellite

(

const ms_quant_satellite &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void copyFrom

(

const ms_quant_satellite *

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 dropModifications

(

)

Delete the modifications element.

Deletes the element until it is re-set.

const ms_quant_modgroup * getModifications

(

)

const

Returns the value of the modifications element.

Returns:

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

std::string getModificationsSchemaType

(

)

const

Obtain a symbolic name for the modifications 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").

bool haveModifications

(

)

const

Check for presence of the modifications element.

Returns:

TRUE if the element is present and FALSE otherwise.

ms_quant_satellite & operator=

(

const ms_quant_satellite &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

void setModifications

(

const ms_quant_modgroup *

mods )

Supply a custom content for modifications element.

Modification group that defines satellite peaks to be summed into the heaviest component to correct for Arg-Pro conversion of SILAC label.

Parameters:

mods	a new content for the element.

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_satellite.hpp
• ms_quant_satellite.cpp