libSBML Perl API
libSBML 5.17.2 Perl API
|
{multi}
multi Entry point for package validation.This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.
The MultiValidator class extends the Validator class from core libSBML to apply validation to the constructs introduced by the SBML Level 3 Multistate, Multicomponent and Multicompartment Species (“multi”) package. This class then acts as a base class for any validators that apply rules to the “fbc” package specification constructs or to entire models that use the “multi” package, and may therefore be subject to other global restrictions introduced.
Public Member Functions | |
virtual void | addConstraint (VConstraint *c) |
Adds the given VContraint object to this validator. More... | |
void | clearFailures () |
Clears this Validator's list of validation failures. More... | |
unsigned int | getCategory () const |
Get the category of validation rules covered by this validator. More... | |
const std::list< SBMLError > & | getFailures () const |
Get the list of SBMLError objects logged during validator execution. More... | |
virtual void | init ()=0 |
Initializes this MultiValidator object. More... | |
void | logFailure (const SBMLError &err) |
Adds the given failure to this list of validation failures. More... | |
MultiValidator (SBMLErrorCategory_t category=LIBSBML_CAT_SBML) | |
Constructor; creates a new MultiValidator object for the given category of validation. More... | |
virtual unsigned int | validate (const SBMLDocument &d) |
Validates the given SBML document. More... | |
virtual unsigned int | validate (const std::string &filename) |
Validates the SBML document located at the given file name. More... | |
virtual | ~MultiValidator () |
Destroys this MultiValidator object. More... | |
MultiValidator::MultiValidator | ( | SBMLErrorCategory_t | category = LIBSBML_CAT_SBML | ) |
Constructor; creates a new MultiValidator object for the given category of validation.
category | code indicating the kind of validations that this validator will perform. The category code value must be |
|
virtual |
Destroys this MultiValidator object.
|
virtual |
Adds the given VContraint object to this validator.
c | the VConstraint ("validator constraint") object to add. |
Reimplemented from Validator.
|
inherited |
|
inherited |
Get the category of validation rules covered by this validator.
|
inherited |
Get the list of SBMLError objects logged during validator execution.
|
pure virtual |
Initializes this MultiValidator object.
When creating a subclass of MultiValidator, override this method to add your own validation code.
Implements Validator.
|
inherited |
Adds the given failure to this list of validation failures.
This method can be used in the implementation of custom validators.
err | the SBMLError object to append. |
|
virtual |
Validates the given SBML document.
d | the SBMLDocument object to be validated. |
Reimplemented from Validator.
|
virtual |
Validates the SBML document located at the given file name.
filename | the path to the file to be read and validated. |
Reimplemented from Validator.