/usr/include/sbml/packages/qual/extension/QualSBMLDocumentPlugin.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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 | /**
* @file QualSBMLDocumentPlugin.h
* @brief Implementation of the QualSBMLDocumentPlugin class
* @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-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 QualSBMLDocumentPlugin
* @sbmlbrief{qual} Extension of SBMLDocument.
*
* The QualSBMLDocumentPlugin class inherits from the SBMLDocumentPlugin
* class, and codifies the extensions to the SBMLDocument class defined in
* the SBML Level 3 @ref qual (“qual”) package.
*
* The QualSBMLDocumentPlugin defines a
* required flag named <code>required</code>, which indicates whether the
* 'qual' constructs can be used to change the core mathematics of the
* <code><model></code> child of the <code><sbml></code> element.
* Because they can not, this attribute must be set @c false.
*/
#ifndef QualSBMLDocumentPlugin_H__
#define QualSBMLDocumentPlugin_H__
#include <sbml/common/extern.h>
#ifdef __cplusplus
#include <sbml/extension/SBMLDocumentPlugin.h>
#include <sbml/packages/qual/extension/QualExtension.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN QualSBMLDocumentPlugin : public SBMLDocumentPlugin
{
public:
/**
* Creates a new QualSBMLDocumentPlugin object using the given parameters.
*
* @copydetails doc_what_are_xmlnamespaces
*
* @copydetails doc_what_are_sbmlnamespaces
*
* @param uri the URI of the SBML Level 3 package implemented by
* this libSBML package extension.
*
* @param prefix the XML namespace prefix being used for the package.
*
* @param qualns the namespaces object for the package.
*/
QualSBMLDocumentPlugin(const std::string& uri, const std::string& prefix,
QualPkgNamespaces* qualns);
/**
* Copy constructor for QualSBMLDocumentPlugin.
*
* @param orig the QualSBMLDocumentPlugin instance to copy.
*/
QualSBMLDocumentPlugin(const QualSBMLDocumentPlugin& orig);
/**
* Assignment operator for QualSBMLDocumentPlugin.
*
* @param rhs the object whose values are used as the basis
* of the assignment
*/
QualSBMLDocumentPlugin& operator=(const QualSBMLDocumentPlugin& rhs);
/**
* Creates and returns a deep copy of this QualSBMLDocumentPlugin object.
*
* @return a (deep) copy of this QualSBMLDocumentPlugin object.
*/
virtual QualSBMLDocumentPlugin* clone () const;
/**
* Destructor for QualSBMLDocumentPlugin.
*/
virtual ~QualSBMLDocumentPlugin();
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Reads the attributes of corresponding package in SBMLDocument element
*/
virtual void readAttributes (const XMLAttributes& attributes,
const ExpectedAttributes& expectedAttributes);
/** @endcond */
#endif // SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Returns boolean based on whether flattening of a comp model has been implemented.
*
* @returns @c true if flattening for composed models has been implemented,
* false otherwise.
*/
virtual bool isCompFlatteningImplemented() const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Check consistency function.
*/
virtual unsigned int checkConsistency();
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Accepts the SBMLVisitor.
*/
virtual bool accept(SBMLVisitor& v) const;
/** @endcond */
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName, bool& value)
const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName, int& value) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName,
double& value) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName,
unsigned int& value) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName,
std::string& value) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to retrieve.
*
* @param value, the address of the value to record.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int getAttribute(const std::string& attributeName,
const char* value) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Predicate returning @c true if this QualSBMLDocumentPlugin's attribute
* "attributeName" is set.
*
* @param attributeName, the name of the attribute to query.
*
* @return @c true if this QualSBMLDocumentPlugin's attribute "attributeName"
* has been set, otherwise @c false is returned.
*/
virtual bool isSetAttribute(const std::string& attributeName) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName, bool value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName, int value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName, double value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName,
unsigned int value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName,
const std::string& value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to set.
*
* @param value, the value of the attribute to set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int setAttribute(const std::string& attributeName, const char*
value);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Unsets the value of the "attributeName" attribute of this
* QualSBMLDocumentPlugin.
*
* @param attributeName, the name of the attribute to query.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int unsetAttribute(const std::string& attributeName);
/** @endcond */
#endif /* !SWIG */
protected:
/** @cond doxygenLibsbmlInternal */
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* QualSBMLDocumentPlugin_H__ */
|