/usr/include/sbml/packages/groups/validator/GroupsValidator.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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | /**
* @file GroupsValidator.h
* @brief Definition of GroupsValidator.
* @author SBMLTeam
*
* <!--------------------------------------------------------------------------
* 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 (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 GroupsValidator
* @sbmlbrief{groups} Entry point for “groups” package validation.
*
* @htmlinclude not-sbml-warning.html
*
* @copydetails doc_common_intro_package_validators
*
* The GroupsValidator class extends the Validator class from core libSBML to
* apply validation to the constructs introduced by the SBML Level 3
* Groups package. This class then acts as a base class for any validators that
* apply rules to the “groups” package specification constructs or
* to entire models that use the “groups” package, and may
* therefore be subject to other global restrictions introduced.
*
* @copydetails doc_section_package_validators_general_info
*/
#ifndef GroupsValidator_H__
#define GroupsValidator_H__
#ifdef __cplusplus
/** @cond doxygenLibsbmlInternal */
#include <list>
#include <string>
/** @endcond */
#include <sbml/SBMLError.h>
#include <sbml/validator/Validator.h>
#include <sbml/SBMLReader.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class VConstraint;
struct GroupsValidatorConstraints;
class SBMLDocument;
class GroupsValidator : public Validator
{
public:
/**
* Creates a new GroupsValidator object for the given category of validation.
*
* @param category code indicating the type of validation that this validator
* will perform.
*/
GroupsValidator(SBMLErrorCategory_t category = LIBSBML_CAT_SBML);
/**
* Destroys this GroupsValidator object.
*/
virtual ~GroupsValidator();
/**
* Initializes this GroupsValidator object.
*
* When creating a subclass of GroupsValidator, override this method to add
* your own validation code.
*/
virtual void init() = 0;
/**
* Adds the given VConstraint object to this GroupsValidator.
*
* @param c the VConstraint ("validator constraint") object to add.
*/
virtual void addConstraint(VConstraint* c);
/**
* Validates the given SBMLDocument
*
* @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 SBMLDocument located at the given filename
*
* @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 */
GroupsValidatorConstraints* mGroupsConstraints;
friend class GroupsValidatingVisitor;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* !GroupsValidator_H__ */
|