Matrix Science header
Public Member Functions

ms_umod_xref Class Reference
[Mascot configuration files module]

Represents the cross references objects in unimod.xml. More...

#include <ms_umod_xref.hpp>

List of all members.

Public Member Functions

 ms_umod_xref ()
 Default constructor.
 ms_umod_xref (const ms_umod_xref &src)
 Copying constructor.
virtual ~ms_umod_xref ()
 Destructor.
void copyFrom (const ms_umod_xref *right)
 Copies all content from another instance.
void defaultValues ()
 Call this member if you want to start again.
void dropSource ()
 Delete the source element.
void dropText ()
 Delete the text element.
void dropUrl ()
 Delete the url element.
virtual std::string getSchemaType () const
 Returns name of the schema type that can be used to validate this element.
std::string getSource () const
 Returns the value of the source element.
std::string getSourceSchemaType () const
 Obtain a symbolic name for the source element schema type.
std::string getText () const
 Returns the value of the text element.
std::string getTextSchemaType () const
 Obtain a symbolic name for the text element schema type.
std::string getUrl () const
 Returns the value of the url element.
std::string getUrlSchemaType () const
 Obtain a symbolic name for the url element schema type.
bool haveSource () const
 Indicates presence of the source element.
bool haveText () const
 Indicates presence of the text element.
bool haveUrl () const
 Indicates presence of the url element.
bool isSameAs (const ms_umod_xref &right) const
 Returns true if instances contain the same information.
ms_umod_xrefoperator= (const ms_umod_xref &right)
 C++ style assignment operator.
void setSource (const char *value)
 Set a custom value for the source element.
void setText (const char *value)
 Set a custom value for the text element.
void setUrl (const char *value)
 Set a custom value for the url 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

Represents the cross references objects in unimod.xml.


Constructor & Destructor Documentation

ms_umod_xref (  )

Default constructor.

Assigns reasonable default values to all internal members.

ms_umod_xref ( const ms_umod_xref src )

Copying constructor.

Parameters:
srcanother instance of this class to copy the content from.

Member Function Documentation

void copyFrom ( const ms_umod_xref right )

Copies all content from another instance.

Parameters:
rightanother 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 dropSource (  )

Delete the source element.

Deletes the element until it is re-set.

void dropText (  )

Delete the text element.

Deletes the element until it is re-set.

void dropUrl (  )

Delete the url element.

Deletes the element until it is re-set.

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")
std::string getSource (  ) const

Returns the value of the source element.

Returns:
current value of the element.
std::string getSourceSchemaType (  ) const

Obtain a symbolic name for the source 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 getText (  ) const

Returns the value of the text element.

Returns:
current value of the element.
std::string getTextSchemaType (  ) const

Obtain a symbolic name for the text 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 getUrl (  ) const

Returns the value of the url element.

Returns:
current value of the element.
std::string getUrlSchemaType (  ) const

Obtain a symbolic name for the url 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.
bool haveSource (  ) const

Indicates presence of the source element.

Returns:
TRUE if the element is present and FALSE otherwise.
bool haveText (  ) const

Indicates presence of the text element.

Returns:
TRUE if the element is present and FALSE otherwise.
bool haveUrl (  ) const

Indicates presence of the url element.

Returns:
TRUE if the element is present and FALSE otherwise.
bool isSameAs ( const ms_umod_xref right ) const

Returns true if instances contain the same information.

Ignores carriage return characters when comparing the text.

Parameters:
rightanother instance of this class to compare.
Returns:
true if the two instances are equivalent.
ms_umod_xref & operator= ( const ms_umod_xref right )

C++ style assignment operator.

Parameters:
rightanother instance of this class to copy the content from.
Returns:
reference to the current object
void setSource ( const char *  value )

Set a custom value for the source element.

Parameters:
valuea new value for the element.
void setText ( const char *  value )

Set a custom value for the text element.

Parameters:
valuea new value for the element.
void setUrl ( const char *  value )

Set a custom value for the url element.

Parameters:
valuea new value 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:
pSchemaFileObja 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:
pSchemaFileObja 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:
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:55