/usr/include/sbml/packages/comp/validator/CompValidator.h is in libsbml5-dev 5.13.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | /**
* @file CompValidator.h
* @brief Base class for SBML CompValidators
* @author Sarah Keating
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2016 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright 2011-2012 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution and
* also available online as http://sbml.org/software/libsbml/license.html
* ---------------------------------------------------------------------- -->
*
* @class CompValidator
* @sbmlbrief{comp} Entry point for package validation.
*
* @htmlinclude not-sbml-warning.html
*
* @copydetails doc_common_intro_package_validators
*
* The CompValidator class extends the Validator class from core libSBML to
* apply validation to the constructs introduced by the SBML Level 3
* Hierarchical Model Composition package. This class then acts as a base
* class for any validators that apply rules to the “comp”
* package specification constructs or to entire models that use the
* “comp” package, and may therefore be subject to other global
* restrictions introduced.
*
* @copydetails doc_section_package_validators_general_info
*/
#ifndef CompValidator_h
#define CompValidator_h
#ifdef __cplusplus
/** @cond doxygenLibsbmlInternal */
#include <list>
#include <string>
/** @endcond */
#include <sbml/SBMLError.h>
#include <sbml/validator/Validator.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class VConstraint;
struct CompValidatorConstraints;
class SBMLDocument;
class CompValidator : public Validator
{
public:
/**
* Constructor; creates a new CompValidator object for the given
* category of validation.
*
* @param category code indicating the kind of validations that this
* validator will perform. The category code value must be
* @if clike taken from the enumeration #SBMLErrorCategory_t @endif@~
* @if java one of of the values from the set of constants whose names
* begin with the characters <code>LIBSBML_CAT_</code> in the interface
* class {@link libsbmlConstants}.@endif@~
* @if python one of of the values from the set of constants whose names
* begin with the characters <code>LIBSBML_CAT_</code> in the interface
* class @link libsbml libsbml@endlink.@endif@~
*/
CompValidator ( SBMLErrorCategory_t category = LIBSBML_CAT_SBML );
/**
* Destroys this CompValidator object.
*/
virtual ~CompValidator ();
/**
* Initializes this CompValidator object.
*
* When creating a subclass of CompValidator, override this method to add
* your own validation code.
*/
virtual void init () = 0;
/**
* Adds the given VContraint object to this validator.
*
* @param c the VConstraint ("validator constraint") object to add.
*/
virtual void addConstraint (VConstraint* c);
/**
* Validates the given SBML document.
*
* @param d the SBMLDocument object to be validated.
*
* @return the number of validation failures that occurred. The objects
* describing the actual failures can be retrieved using getFailures().
*/
virtual unsigned int validate (const SBMLDocument& d);
/**
* Validates the SBML document located at the given file name.
*
* @param filename the path to the file to be read and validated.
*
* @return the number of validation failures that occurred. The objects
* describing the actual failures can be retrieved using getFailures().
*/
virtual unsigned int validate (const std::string& filename);
protected:
/** @cond doxygenLibsbmlInternal */
CompValidatorConstraints* mCompConstraints;
friend class CompValidatingVisitor;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* CompValidator_h */
|