/usr/include/sbml/validator/VConstraint.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 | /**
* @file VConstraint.h
* @brief Base class for all SBML Validator Constraints
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* 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 VConstraint
* @sbmlbrief{core} Helper class for SBML validators.
*
* @htmlinclude not-sbml-warning.html
*
*/
#ifndef Validator_Constraint_h
#define Validator_Constraint_h
#ifdef __cplusplus
#include <string>
#include <sbml/SBase.h>
#include <sbml/validator/Validator.h>
#include <sbml/units/UnitFormulaFormatter.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class Model;
class LIBSBML_EXTERN VConstraint
{
public:
/**
* Creates a new VConstraint with the given @p id and Validator @p v.
*
* The severity of the constraint is set to 2 by default.
*
* @param id an integer, the id of the new VConstraint.
* @param v a Validator for the new VContraint.
*/
VConstraint (unsigned int id, Validator& v);
/**
* Destructor for the VConstraint object.
*/
virtual ~VConstraint ();
/**
* Get the constraint identifier of this constraint.
*
* Note that constraint identifiers are unrelated to SBML identifiers put
* on SBML components. Constraint identifiers are a superset of the
* validation rule numbers. (These "validation rules" are defined in the
* SBML specifications beginning with SBML Level 2 Version 2.)
* The set of possible constraint identifiers includes all SBML
* validation rule numbers, and in addition, there exist extra
* constraints defined by libSBML itself.
*
* @return the id of this Constraint.
*/
unsigned int getId () const;
/**
* Get the severity of this constraint.
*
* Severity codes are defined by the enumeration #SBMLErrorSeverity_t.
* See the documentation included in SBMLError for more information.
*
* @return the severity for violating this Constraint.
*
* @see SBMLErrorSeverity_t
*/
unsigned int getSeverity () const;
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Logs a constraint failure to the validator for the given SBML object.
*/
void logFailure (const SBase& object);
/**
* Logs a constraint failure to the validator for the given SBML object.
* The parameter message is used instead of the constraint's member
* variable msg.
*/
void logFailure (const SBase& object, const std::string& message);
unsigned int mId;
unsigned int mSeverity;
Validator& mValidator;
bool mLogMsg;
std::string msg;
/** @endcond */
};
/** @cond doxygenLibsbmlInternal */
template <typename T>
class TConstraint : public VConstraint
{
public:
TConstraint (unsigned int id, Validator& v) : VConstraint(id, v) { }
virtual ~TConstraint () { };
/**
* Checks to see if this Contraint holds when applied to the given SBML
* object of type T. The Model object should contain object and is
* passed in to provide additional context information, should the
* contraint need it.
*/
void check (const Model& m, const T& object)
{
mLogMsg = false;
check_(m, object);
if (mLogMsg) logFailure(object);
}
protected:
/** @cond doxygenLibsbmlInternal */
/**
* The check method delegates to this virtual method.
*/
virtual void check_ (const Model&, const T&) { };
/** @endcond */
};
/** @endcond */
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* Validator_Constraint_h */
|