Validator Class Reference

Inheritance diagram for Validator:

Detailed Description

Entry point for SBML validation rules in libSBML.

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.

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 Validator 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 SBML document. More...
virtual unsigned int	validate (const std::string &filename)
	Validates the SBML document located at the given file name. More...
	Validator (SBMLErrorCategory_t category=LIBSBML_CAT_SBML)
	Constructor; creates a new Validator object for the given category of validation. More...
virtual	~Validator ()
	Destroys this Validator object. More...

Constructor & Destructor Documentation

Validator()

Validator::Validator

(

SBMLErrorCategory_t

category = LIBSBML_CAT_SBML

)

Constructor; creates a new Validator object for the given category of validation.

Parameters

category

code indicating the kind of validations that this validator will perform. The category code value must be taken from the enumeration SBMLErrorCategory_t

~Validator()

Validator::~Validator ( )

virtual

Destroys this Validator object.

Member Function Documentation

addConstraint()

void Validator::addConstraint ( VConstraint *  c )

virtual

Adds the given VContraint object to this validator.

Parameters

c	the VConstraint ("validator constraint") object to add.

Reimplemented in SpatialValidator, RenderValidator, QualValidator, MultiValidator, LayoutValidator, GroupsValidator, FbcValidator, DistribValidator, and CompValidator.

clearFailures()

void Validator::clearFailures

(

)

Clears this Validator's list of validation failures.

If you are validating multiple SBML documents with the same Validator, call this method after you have processed the list of failures from the last Validation run and before validating the next document.

getCategory()

unsigned int Validator::getCategory

(

)

const

Get the category of validation rules covered by this validator.

Returns

an integer code representing the category of validator rules covered by this validator class. The category values are drawn from the enumeration SBMLErrorCategory_t. See the documentation for the class SBMLError for more information.

getFailures()

const std::list< SBMLError > & Validator::getFailures

(

)

const

Get the list of SBMLError objects logged during validator execution.

Returns

a list of failures logged during validation. The list may be empty if no errors or other diagnostics were logged by the validator.

init()

virtual void Validator::init ( )

pure virtual

Initializes this Validator object.

When creating a subclass of Validator, override this method to add your own validation code.

Implemented in SpatialValidator, RenderValidator, QualValidator, MultiValidator, LayoutValidator, GroupsValidator, FbcValidator, DistribValidator, and CompValidator.

logFailure()

void Validator::logFailure

(

const SBMLError &

err

)

Adds the given failure to this list of validation failures.

This method can be used in the implementation of custom validators.

Parameters

err	the SBMLError object to append.

validate() [1/2]

unsigned int Validator::validate ( const SBMLDocument &  d )

virtual

Validates the given SBML document.

Parameters

d	the SBMLDocument object to be validated.

Returns

the number of validation failures that occurred. The objects describing the actual failures can be retrieved using getFailures().

Reimplemented in SpatialValidator, RenderValidator, QualValidator, MultiValidator, LayoutValidator, GroupsValidator, FbcValidator, DistribValidator, and CompValidator.

validate() [2/2]

unsigned int Validator::validate ( const std::string &  filename )

virtual

Validates the SBML document located at the given file name.

Parameters

filename

the path to the file to be read and validated.

Returns

the number of validation failures that occurred. The objects describing the actual failures can be retrieved using getFailures().

Reimplemented in SpatialValidator, RenderValidator, QualValidator, MultiValidator, LayoutValidator, GroupsValidator, FbcValidator, DistribValidator, and CompValidator.