libSBML C++ API 5.8.0
Entry point for libSBML's implementation of SBML validation rules.
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.
LibSBML implements facilities for verifying that a given SBML document is valid according to the SBML specifications; it also exposes the validation interface so that user programs and SBML Level 3 package authors may use the facilities to implement new validators. There are two main interfaces to libSBML's validation facilities, based on the classes Validator and SBMLValidator.
The Validator class is the basis of the system for validating an SBML document against the validation rules defined in the SBML specifications. The scheme used by Validator relies is compact and uses the visitor programming pattern, but it relies on C/C++ features and is not directly accessible from language bindings. SBMLValidator offers a framework for straightforward class-based extensibility, so that user code can subclass SBMLValidator to implement new validation systems, different validators can be introduced or turned off at run-time, and interfaces can be provided in the libSBML language bindings. SBMLValidator can call Validator functionality internally (as is the case in the current implementation of SBMLInternalValidator) or use entirely different implementation approaches, as necessary.
|virtual void||addConstraint (VConstraint *c)|
|Adds the given VContraint object to this validator. |
|Clears this Validator's list of validation failures. |
|const unsigned int||getCategory () const|
|Get the category of validation rules covered by this validator. |
|const std::list< SBMLError > &||getFailures () const|
|Get the list of SBMLError objects (if any) logged as a result of running the validator. |
|virtual void||init ()=0|
|Initializes this Validator object. |
|void||logFailure (const SBMLError &err)|
|Adds the given failure to this list of Validators failures. |
|virtual unsigned int||validate (const SBMLDocument &d)|
|Validates the given SBML document. |
|virtual unsigned int||validate (const std::string &filename)|
|Validates the SBML document located at the given file name. |
|Validator (SBMLErrorCategory_t category=LIBSBML_CAT_SBML)|
|Constructor; creates a new Validator object for the given category of validation. |
|Destroys this Validator object. |
Destroys this Validator object.
|const unsigned int Validator::getCategory||(||)||const|
|const std::list< SBMLError > & Validator::getFailures||(||)||const|
Get the list of SBMLError objects (if any) logged as a result of running the validator.
|void Validator::logFailure||(||const SBMLError &||err||)|
Adds the given failure to this list of Validators failures.
|err||the SBMLError object to append.|
Validates the SBML document located at the given file name.
|filename||the path to the file to be read and validated.|