ms_crosslinking_accession Class Reference [Mascot configuration files module]

Accession element in crosslinking.xml More...

#include <ms_crosslinking_accession.hpp>

List of all members.

Public Member Functions
	ms_crosslinking_accession ()
	Default constructor.
	ms_crosslinking_accession (const ms_crosslinking_accession &src)
	Copying constructor.
virtual	~ms_crosslinking_accession ()
	Destructor.
void	copyFrom (const ms_crosslinking_accession *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
void	dropDatabaseName ()
	Delete the DatabaseName attribute.
void	dropValue ()
	Delete the custom text.
std::string	getDatabaseName () const
	Returns the value of the DatabaseName attribute.
std::string	getDatabaseNameSchemaType () const
	Obtain a symbolic name for the DatabaseName attribute schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
std::string	getValue () const
	Returns the text of the node.
std::string	getValueSchemaType () const
	Obtain a symbolic name for the text node schema type.
bool	haveDatabaseName () const
	Indicates presence of the DatabaseName attribute.
bool	haveValue () const
	Returns the text of the node.
ms_crosslinking_accession &	operator= (const ms_crosslinking_accession &right)
	C++ style assignment operator.
void	setDatabaseName (const char *value)
	Set a custom value for the DatabaseName attribute.
void	setValue (const char *value)
	Set a custom text.
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

Accession element in crosslinking.xml

Accessions may come from different databases. If an accession has no DatabaseName attribute, the accession is looked up in all databases selected for the search.

---

Constructor & Destructor Documentation

ms_crosslinking_accession

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_crosslinking_accession

(

const ms_crosslinking_accession &

src )

Copying constructor.

Parameters:

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

---

Member Function Documentation

void copyFrom

(

const ms_crosslinking_accession *

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 dropDatabaseName

(

)

Delete the DatabaseName attribute.

Deletes the attribute until is re-set.

std::string getDatabaseName

(

)

const

Returns the value of the DatabaseName attribute.

Returns:

current value of the attribute.

std::string getDatabaseNameSchemaType

(

)

const

Obtain a symbolic name for the DatabaseName 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, "mxm:nameType").

std::string getValue

(

)

const

Returns the text of the node.

Returns:

current value text.

std::string getValueSchemaType

(

)

const

Obtain a symbolic name for the text node 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 haveDatabaseName

(

)

const

Indicates presence of the DatabaseName attribute.

Returns:

TRUE if the attribute is present and FALSE otherwise.

ms_crosslinking_accession & operator=

(

const ms_crosslinking_accession &

right )

C++ style assignment operator.

Parameters:

right

another instance of this class to copy the content from.

Returns:

reference to the current object

void setDatabaseName

(

const char *

value )

Set a custom value for the DatabaseName attribute.

Parameters:

value

a new value for the attribute.

void setValue

(

const char *

value )

Set a custom text.

Parameters:

value

a new value text.

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_crosslinking_accession.hpp
• ms_crosslinking_accession.cpp