/usr/include/sbml/validator/SBMLExternalValidator.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 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 | /**
* @cond doxygenLibsbmlInternal
*
* @file SBMLExternalValidator.h
* @brief Definition of SBMLExternalValidator, a validator calling external programs
* @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-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 SBMLExternalValidator
* @sbmlbrief{core}
*/
#ifndef SBMLExternalValidator_h
#define SBMLExternalValidator_h
#include <sbml/SBMLNamespaces.h>
#include <sbml/validator/SBMLValidator.h>
#ifndef LIBSBML_USE_STRICT_INCLUDES
#include <sbml/SBMLTypes.h>
#endif
#ifdef __cplusplus
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN SBMLExternalValidator : public SBMLValidator
{
public:
/**
* Constructor.
*/
SBMLExternalValidator();
/**
* Copy constructor.
*/
SBMLExternalValidator(const SBMLExternalValidator&);
/**
* Creates and returns a deep copy of this SBMLValidator object.
*
* @return the (deep) copy of this SBMLValidator object.
*/
virtual SBMLValidator* clone() const;
/**
* Destroy this object.
*/
virtual ~SBMLExternalValidator ();
/**
* the actual conversion
*
* @return status code represeting success/failure/conversion impossible
*/
virtual unsigned int validate();
/**
* Returns the program name of the validator to be run
*
* @return the program name of the validator to be run
*/
const std::string& getProgram() const;
/**
* Sets the name of the program to run
*
* @param program the program to be started
*/
void setProgram (std::string program);
/**
* Returns the output file name (this is the file the external program will write)
*
* @return the output file name
*/
const std::string& getOutputFileName() const;
/**
* Sets the output file name
*
* @param outputFileName the name of the output XML file
*/
void setOutputFileName(std::string outputFileName);
/**
* @return the name of the SBML file (the document of this validator will be written to it)
*/
const std::string& getSBMLFileName() const;
/**
* Sets the filename for the temporary file to be created
*
* @param sbmlFileName the temporary name
*/
void setSBMLFileName(std::string sbmlFileName);
/**
* Clear all additional arguments
*/
void clearArguments();
/**
* Adds the given argument to the list of additional arguments
*
* @param arg the argument
*/
void addArgument(std::string arg);
/**
* @return the number of arguments.
*/
unsigned int getNumArguments() const;
/**
* Returns the argument for the given index.
*
* @param n the zero based index of the argument.
*
* @return the argument at the given index.
*/
std::string getArgument(unsigned int n) const;
/**
* @return all arguments
*/
const std::vector<std::string>& getArguments() const;
/**
* Sets the additional arguments
*
* @param args the additional arguments
*/
void setArguments(std::vector<std::string> args);
protected:
std::string mProgram;
std::vector<std::string> mArguments;
std::string mSBMLFileName;
std::string mOutputFileName;
private:
};
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 /* SBMLExternalValidator_h */
/** @endcond */
|