/usr/include/sbml/extension/SBMLDocumentPluginNotRequired.h is in libsbml5-dev 5.10.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 | /**
* @file SBMLDocumentPluginNotRequired.h
* @brief Definition of SBMLDocumentPluginNotRequired, the plugin class of
* layout package for the SBMLDocument element, whose 'required' attribute
* must be 'false'.
* @author Lucian Smith
*
*
* <!--------------------------------------------------------------------------
* 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-2014 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 SBMLDocumentPluginNotRequired
* @sbmlbrief{core} Template class for the %SBMLDocument Plugin class for
* non-required packages.
*
* The SBMLDocumentPluginNotRequired class extends the SBMLDocumentPlugin class, and
* will add a validation error to a read-in SBML Document that has the package's
* 'required' flag set to @c true: for all packages, the value of the 'required' flag
* is set by the specification itself to be @c true or @c false, depending on whether
* constructs in the package can potentially be used to change the mathematics of
* the model.
*/
#ifndef SBMLDocumentPluginNotRequired_h
#define SBMLDocumentPluginNotRequired_h
#ifdef __cplusplus
#include <sbml/extension/SBMLDocumentPlugin.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN SBMLDocumentPluginNotRequired : public SBMLDocumentPlugin
{
public:
/**
* Constructor
*/
SBMLDocumentPluginNotRequired (const std::string &uri, const std::string &prefix,
SBMLNamespaces *sbmlns);
/**
* Copy constructor. Creates a copy of this SBase object.
*/
SBMLDocumentPluginNotRequired(const SBMLDocumentPluginNotRequired& orig);
/**
* Assignment operator for SBMLDocumentPlugin.
*/
SBMLDocumentPluginNotRequired& operator=(const SBMLDocumentPluginNotRequired& orig);
/**
* Destroy this object.
*/
virtual ~SBMLDocumentPluginNotRequired ();
#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
#if (0)
/**
*
* Sets the bool value of "required" attribute of corresponding package
* in SBMLDocument element. This package is required to set this value
* to 'false'; attempting to set it to 'true' will result in an error.
*
* @param value the bool value of "required" attribute of corresponding
* package in SBMLDocument element.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
* @li @link OperationReturnValues_t#LIBSBML_UNEXPECTED_ATTRIBUTE LIBSBML_UNEXPECTED_ATTRIBUTE @endlink
*/
virtual int setRequired(bool value);
/**
* Doesn't do anything: it is illegal to unset the 'required' attribute in this package,
* as it must always be set to 'false'.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
*/
virtual int unsetRequired();
#endif //0
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* SBMLDocumentPluginNotRequired_h */
|