/usr/include/sbml/validator/SBMLValidator.h is in libsbml5-dev 5.16.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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | /**
* @file SBMLValidator.h
* @brief Definition of SBMLValidator, the base class for user callable SBML validators.
* @author Frank Bergmann
*
* <!--------------------------------------------------------------------------
* 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-2017 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 (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* 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 SBMLValidator
* @sbmlbrief{core} Base class for SBML validators.
*
* @htmlinclude not-sbml-warning.html
*
* 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 @em 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.
*
* Users of libSBML may already be familiar with the facilities encompassed
* by the validation system, in the form of the consistency-checking methods
* defined on SBMLDocument. The methods SBMLDocument::setConsistencyChecks(@if java int, boolean@endif),
* SBMLDocument::checkConsistency(), SBMLDocument::checkInternalConsistency()
* and other method of that sort are in fact implemented via SBMLValidator,
* specifically as methods on the class SBMLInternalValidator.
*
* Authors may use SBMLValidator as the base class for their own validator
* extensions to libSBML. The class SBMLInternalValidator may serve as a
* code example for how to implement such things.
*/
#ifndef SBMLValidator_h
#define SBMLValidator_h
#include <sbml/SBMLNamespaces.h>
#ifndef LIBSBML_USE_STRICT_INCLUDES
#include <sbml/SBMLTypes.h>
#endif
#ifdef __cplusplus
LIBSBML_CPP_NAMESPACE_BEGIN
class SBMLErrorLog;
class LIBSBML_EXTERN SBMLValidator
{
public:
/**
* Creates a new SBMLValidator.
*/
SBMLValidator ();
/**
* Copy constructor; creates a copy of an SBMLValidator object.
*
* @param orig the object to copy.
*/
SBMLValidator(const SBMLValidator& orig);
/**
* Destroy this object.
*/
virtual ~SBMLValidator ();
/**
* Assignment operator for SBMLValidator.
*
* @param rhs the object whose values are used as the basis of the
* assignment.
*/
SBMLValidator& operator=(const SBMLValidator& rhs);
/**
* Creates and returns a deep copy of this SBMLValidator object.
*
* @return the (deep) copy of this SBMLValidator object.
*/
virtual SBMLValidator* clone() const;
/**
* Returns the current SBML document in use by this validator.
*
* @return the current SBML document.
*
* @see setDocument(@if java SBMLDocument@endif)
*/
virtual SBMLDocument* getDocument();
/**
* Returns the current SBML document in use by this validator.
*
* @return a const reference to the current SBML document.
*
* @see setDocument(@if java SBMLDocument@endif)
*/
virtual const SBMLDocument* getDocument() const;
/**
* Sets the current SBML document to the given SBMLDocument object.
*
* @param doc the document to use for this validation.
*
* @copydetails doc_returns_one_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
*
* @see getDocument()
*/
virtual int setDocument(const SBMLDocument* doc);
/**
* Runs this validator on the current SBML document.
*
* @return an integer value indicating the success/failure of the
* validation. @if clike The value is drawn from the enumeration
* #OperationReturnValues_t. @endif@~ The possible values returned by this
* function are determined by the specific subclasses of this class.
*/
virtual unsigned int validate();
/**
* Clears this validator's list of 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.
*
* @if clike @see getFailures() @endif@~
*/
virtual void clearFailures ();
/**
* Returns a list of SBMLError objects (if any) that were logged by the
* last run of this validator.
*
* @return a list of errors, warnings and other diagnostics logged during
* validation.
*
* @see clearFailures()
*/
const std::vector<SBMLError>& getFailures () const;
/**
* Adds the given failure to this list of Validators failures.
*
* @param err an SBMLError object representing an error or warning.
*
* @if clike @see getFailures() @endif@~
*/
void logFailure (const SBMLError& err);
/**
* Validates the given SBMLDocument object.
*
* This is identical to calling setDocument(@if java SBMLDocument @endif)
* followed by validate().
*
* @param d the SBML document to validate.
*
* @return the number of validation failures that occurred. The objects
* describing the actual failures can be retrieved using getFailures().
*/
unsigned int validate (const SBMLDocument& d);
/**
* Validates the SBML document located at the given @p filename.
*
* This is a convenience method that saves callers the trouble of
* using SBMLReader to read the document first.
*
* @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().
*/
unsigned int validate (const std::string& filename);
/**
* Returns the list of errors or warnings logged during parsing,
* consistency checking, or attempted translation of this model.
*
* Note that this refers to the SBMLDocument object's error log (i.e.,
* the list returned by SBMLDocument::getErrorLog()). @em That list of
* errors and warnings is @em separate from the validation failures
* tracked by this validator (i.e., the list returned by getFailures()).
*
* @return the SBMLErrorLog used for the SBMLDocument.
*
* @if clike @see getFailures() @endif@~
*/
SBMLErrorLog* getErrorLog ();
/**
* Returns the Model object stored in the SBMLDocument.
*
* It is important to note that this method <em>does not create</em> a
* Model instance. The model in the SBMLDocument must have been created
* at some prior time, for example using SBMLDocument::createModel()
* or SBMLDocument::setModel(@if java Model@endif).
* This method returns @c NULL if a model does not yet exist.
*
* @return the Model contained in this validator's SBMLDocument object.
*
* @see SBMLDocument::setModel(@if java Model@endif)
* @see SBMLDocument::createModel()
*/
const Model* getModel () const;
/**
* Returns the Model object stored in the SBMLDocument.
*
* It is important to note that this method <em>does not create</em> a
* Model instance. The model in the SBMLDocument must have been created
* at some prior time, for example using SBMLDocument::createModel()
* or SBMLDocument::setModel(@if java Model@endif).
* This method returns @c NULL if a model does not yet exist.
*
* @return the Model contained in this validator's SBMLDocument object.
*
* @see SBMLDocument::setModel(@if java Model@endif)
* @see SBMLDocument::createModel()
*/
Model* getModel ();
/**
* Returns the number of failures encountered in the last validation run.
*
* This method returns the number of failures logged by this validator.
* This number only reflects @em this validator's actions; the number may
* not be the same as the number of errors and warnings logged on the
* SBMLDocument object's error log (i.e., the object returned by
* SBMLDocument::getErrorLog()), because other parts of libSBML may log
* errors and warnings beyond those found by this validator.
*
* @return the number of errors logged by this validator.
*/
unsigned int getNumFailures() const;
/**
* Returns the failure object at index n in this validator's list of
* failures logged during the last run.
*
* Callers should use getNumFailures() first, to find out the number
* of entries in this validator's list of failures.
*
* @param n an integer indicating the index of the object to return from
* the failures list; index values start at 0.
*
* @return the failure at the given index number.
*
* @see getNumFailures()
*/
SBMLError* getFailure (unsigned int n) const;
#ifndef SWIG
#endif // SWIG
protected:
/** @cond doxygenLibsbmlInternal */
std::vector<SBMLError> mFailures;
SBMLDocument * mDocument;
friend class SBMLDocument;
/** @endcond */
private:
/** @cond doxygenLibsbmlInternal */
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* SBMLValidator_h */
|