libSBML Perl API
libSBML 5.17.2 Perl API
|
{groups}
groups Entry point for “groups” 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 GroupsValidator class extends the Validator class from core libSBML to apply validation to the constructs introduced by the SBML Level 3 Groups package. This class then acts as a base class for any validators that apply rules to the “groups” package specification constructs or to entire models that use the “groups” package, and may therefore be subject to other global restrictions introduced.
Public Member Functions | |
virtual void | addConstraint (VConstraint *c) |
Adds the given VConstraint object to this GroupsValidator. 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... | |
GroupsValidator (SBMLErrorCategory_t category=LIBSBML_CAT_SBML) | |
Creates a new GroupsValidator object for the given category of validation. More... | |
virtual void | init ()=0 |
Initializes this GroupsValidator object. More... | |
void | logFailure (const SBMLError &err) |
Adds the given failure to this list of validation failures. More... | |
virtual unsigned int | validate (const SBMLDocument &d) |
Validates the given SBMLDocument. More... | |
virtual unsigned int | validate (const std::string &filename) |
Validates the SBMLDocument located at the given filename. More... | |
virtual | ~GroupsValidator () |
Destroys this GroupsValidator object. More... | |
GroupsValidator::GroupsValidator | ( | SBMLErrorCategory_t | category = LIBSBML_CAT_SBML | ) |
Creates a new GroupsValidator object for the given category of validation.
category | code indicating the type of validation that this validator will perform. |
|
virtual |
Destroys this GroupsValidator object.
|
virtual |
Adds the given VConstraint object to this GroupsValidator.
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 GroupsValidator object.
When creating a subclass of GroupsValidator, 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 SBMLDocument.
d | the SBMLDocument object to be validated. |
Reimplemented from Validator.
|
virtual |
Validates the SBMLDocument located at the given filename.
filename | the path to the file to be read and validated. |
Reimplemented from Validator.