ms_umod_elemref Class Reference

Represents the elemref_t type in unimod.xml. More...

#include <ms_umod_elemref.hpp>

Inherits ms_xml_IValidatable.

Public Member Functions
	ms_umod_elemref ()
	Default constructor.
	ms_umod_elemref (const ms_quant_element &src)
	Copying constructor.
	ms_umod_elemref (const ms_umod_elemref &src)
	Copying constructor.
virtual	~ms_umod_elemref ()
	Destructor.
void	copyFrom (const ms_quant_element *right)
	Copies all content from another object.
void	copyFrom (const ms_umod_elemref *right)
	Copies all content from another instance.
void	defaultValues ()
	Call this member if you want to start again.
void	dropNumber ()
	Delete the number attribute.
void	dropSymbol ()
	Delete the symbol attribute.
int	getNumber () const
	Returns the value of the number attribute.
std::string	getNumberSchemaType () const
	Obtain a symbolic name for the number attribute schema type.
virtual std::string	getSchemaType () const
	Returns name of the schema type that can be used to validate this element.
std::string	getSymbol () const
	Returns the value of the symbol attribute.
std::string	getSymbolSchemaType () const
	Obtain a symbolic name for the symbol attribute schema type.
bool	haveNumber () const
	Indicates presence of the number attribute.
bool	haveSymbol () const
	Indicates presence of the symbol attribute.
ms_umod_elemref &	operator= (const ms_umod_elemref &right)
	C++ style assignment operator.
void	setNumber (const int value)
	Set a custom value for the number attribute.
void	setSymbol (const char *value)
	Set a custom value for the symbol 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

Represents the elemref_t type in unimod.xml.

This type is used for compositions in order to specify number of each chemical element used in a composition.

Constructor & Destructor Documentation

ms_umod_elemref() [1/3]

ms_umod_elemref

(

)

Default constructor.

Assigns reasonable default values to all internal members.

ms_umod_elemref() [2/3]

ms_umod_elemref

(

const ms_umod_elemref &

src

)

Copying constructor.

Parameters

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

ms_umod_elemref() [3/3]

ms_umod_elemref

(

const ms_quant_element &

src

)

Copying constructor.

Parameters

src	another object to copy the content from.

Member Function Documentation

copyFrom() [1/2]

void copyFrom

(

const ms_quant_element *

right

)

Copies all content from another object.

Parameters

right

another object to copy the content from.

copyFrom() [2/2]

void copyFrom

(

const ms_umod_elemref *

right

)

Copies all content from another instance.

Parameters

right

another instance of this class to copy the content from.

defaultValues()

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.

dropNumber()

void dropNumber

(

)

Delete the number attribute.

Deletes the attribute until it is re-set.

dropSymbol()

void dropSymbol

(

)

Delete the symbol attribute.

Deletes the attribute until it is re-set.

getNumber()

int getNumber

(

)

const

Returns the value of the number attribute.

Returns

current value of the attribute.

getNumberSchemaType()

std::string getNumberSchemaType

(

)

const

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

getSchemaType()

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

getSymbol()

std::string getSymbol

(

)

const

Returns the value of the symbol attribute.

Returns

current value of the attribute.

getSymbolSchemaType()

std::string getSymbolSchemaType

(

)

const

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

haveNumber()

bool haveNumber

(

)

const

Indicates presence of the number attribute.

Returns

TRUE if the attribute is present and FALSE otherwise.

haveSymbol()

bool haveSymbol

(

)

const

Indicates presence of the symbol attribute.

Returns

TRUE if the attribute is present and FALSE otherwise.

operator=()

ms_umod_elemref & operator=

(

const ms_umod_elemref &

right

)

C++ style assignment operator.

Parameters

right

another instance of this class to copy the content from.

Returns

reference to the current object

setNumber()

void setNumber

(

const int

value

)

Set a custom value for the number attribute.

Parameters

value

a new value for the attribute.

setSymbol()

void setSymbol

(

const char *

value

)

Set a custom value for the symbol attribute.

Parameters

value

a new value for the attribute.

validateDeep()

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.

validateShallow()

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_umod_elemref.hpp
• ms_umod_elemref.cpp