ms_quant_unmodified Class Reference [Mascot configuration files module]

Describes an unmodified element in quantitation.xml. More...

#include <ms_quant_unmodified.hpp>

List of all members.

Public Member Functions
	ms_quant_unmodified ()
	Default constructor.
	ms_quant_unmodified (const ms_quant_unmodified &src)
	Copying constructor.
virtual	~ms_quant_unmodified ()
	Destructor.
void	copyFrom (const ms_quant_unmodified *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
void	dropPosition ()
	Deletes the position attribute.
void	dropSite ()
	Deletes the site attribute.
std::string	getContent () const
	Returns string value of the element.
std::string	getContentSchemaType () const
	Obtain a symbolic name for the element's schema type.
std::string	getPosition () const
	Returns the value of the position attribute.
std::string	getPositionSchemaType () const
	Obtain a symbolic name for the position attribute schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
std::string	getSite () const
	Returns the value of the site attribute.
std::string	getSiteSchemaType () const
	Obtain a symbolic name for the site attribute schema type.
bool	havePosition () const
	Indicates whether the position attribute is present or not.
bool	haveSite () const
	Indicates whether the site attribute is present or not.
ms_quant_unmodified &	operator= (const ms_quant_unmodified &right)
	C++ style assignment operator.
void	setContent (const char *value)
	Set a custom value for the the element.
void	setPosition (const char *position)
	Set a custom value for the position attribute.
void	setSite (const char *site)
	Set a custom value for the site 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

Describes an unmodified element in quantitation.xml.

---

Constructor & Destructor Documentation

ms_quant_unmodified

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_quant_unmodified

(

const ms_quant_unmodified &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void copyFrom

(

const ms_quant_unmodified *

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 dropPosition

(

)

Deletes the position attribute.

Disables the attribute until it is re-set.

void dropSite

(

)

Deletes the site attribute.

Disables the attribute until it is re-set.

std::string getContent

(

)

const

Returns string value of the element.

Returns:

string content of the element.

std::string getContentSchemaType

(

)

const

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.

std::string getPosition

(

)

const

Returns the value of the position attribute.

Returns:

current value of the position attribute.

std::string getPositionSchemaType

(

)

const

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

std::string getSite

(

)

const

Returns the value of the site attribute.

Returns:

current value of the site attribute.

std::string getSiteSchemaType

(

)

const

Obtain a symbolic name for the site 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 havePosition

(

)

const

Indicates whether the position attribute is present or not.

Returns:

TRUE if the attribute is available.

bool haveSite

(

)

const

Indicates whether the site attribute is present or not.

Returns:

TRUE if the attribute is available.

ms_quant_unmodified & operator=

(

const ms_quant_unmodified &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

void setContent

(

const char *

value )

Set a custom value for the the element.

Parameters:

value

new content for the element.

void setPosition

(

const char *

position )

Set a custom value for the position attribute.

Calling this method makes the attribute automatically available in the current element.

Parameters:

position

a new value for the position attribute.

void setSite

(

const char *

site )

Set a custom value for the site attribute.

Calling this method makes the attribute automatically available in the current element.

Parameters:

site	a new value for the site 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_unmodified.hpp
• ms_quant_unmodified.cpp