/usr/include/sbml/packages/qual/extension/QualModelPlugin.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 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 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 | /**
* @file QualModelPlugin.h
* @brief Definition of QualModelPlugin, the plugin class of
* qual package for the Model element.
* @author Akiya Jouraku
*
* <!--------------------------------------------------------------------------
* 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-2011 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 QualModelPlugin
* @sbmlbrief{qual} Implementation of the 'qual' package extention to the
* %Model construct. The extension of SBML Level 3 Core's Model class is
* relatively straightforward: the Qualitative Models Package adds two lists,
* one for holding qualitativeSpecies (ListOfQualitativeSpecies), and the
* other for holding transitions (ListOfTransitions). The Model element may
* contain at most one ListOfQualitativeSpecies, which must contain at least
* one QualitativeSpecies. It may also contain at most one ListOfTransitions
* which must contain at least one Transition.
*/
#ifndef QualModelPlugin_h
#define QualModelPlugin_h
#include <sbml/common/extern.h>
#ifdef __cplusplus
#include <sbml/extension/SBasePlugin.h>
#include <sbml/packages/qual/sbml/QualitativeSpecies.h>
#include <sbml/packages/qual/sbml/Transition.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN QualModelPlugin : public SBasePlugin
{
public:
/**
* Constructor
*/
QualModelPlugin (const std::string &uri, const std::string &prefix,
QualPkgNamespaces *qualns);
/**
* Copy constructor. Creates a copy of this SBase object.
*/
QualModelPlugin(const QualModelPlugin& orig);
/**
* Destroy this object.
*/
virtual ~QualModelPlugin ();
/**
* Assignment operator for QualModelPlugin.
*/
QualModelPlugin& operator=(const QualModelPlugin& orig);
/**
* Creates and returns a deep copy of this QualModelPlugin object.
*
* @return a (deep) copy of this SBase object
*/
virtual QualModelPlugin* clone () const;
// --------------------------------------------------------
//
// overridden virtual functions for reading/writing/checking
// elements
//
// --------------------------------------------------------
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses must override this method to create, store, and then
* return an SBML object corresponding to the next XMLToken in the
* XMLInputStream if they have their specific elements.
*
* @return the SBML object corresponding to next XMLToken in the
* XMLInputStream or NULL if the token was not recognized.
*/
virtual SBase* createObject (XMLInputStream& stream);
/**
* Subclasses must override this method to write out their contained
* SBML objects as XML elements if they have their specific elements.
*/
virtual void writeElements (XMLOutputStream& stream) const;
/**
* Checks if this plugin object has all the required elements.
*
* Subclasses should override this function if they have their specific
* elements.
*
* @return true if this plugin object has all the required elements,
* otherwise false will be returned.
*/
virtual bool hasRequiredElements() const ;
/** ------------------------------------------------------------------
*
* Additional public functions
*
* ------------------------------------------------------------------
*/
/** @cond doxygenLibsbmlInternal */
int appendFrom(const Model* model);
/** @endcond */
/**
* Returns a List of all child SBase objects, including those nested to an
* arbitary depth.
*
* @return a List* of pointers to all child objects.
*/
virtual List* getAllElements(ElementFilter * filter = NULL);
/**
* Returns the ListOfQualitativeSpecies in this plugin object.
*
* @return ListOfQualitativeSpecies object in this plugin object.
*/
const ListOfQualitativeSpecies* getListOfQualitativeSpecies () const;
/**
* Returns the ListOfQualitativeSpecies in this plugin object.
*
* @return ListOfQualitativeSpecies object in this plugin object.
*/
ListOfQualitativeSpecies* getListOfQualitativeSpecies ();
/**
* Returns the QualitativeSpecies object that belongs to the given index. If the
* index is invalid, NULL is returned.
*
* @param n the index number of the QualitativeSpecies to get.
*
* @return the nth QualitativeSpecies in the ListOfQualitativeSpecies.
*/
const QualitativeSpecies* getQualitativeSpecies (unsigned int n) const;
/**
* Returns the QualitativeSpecies object that belongs to the given index. If the
* index is invalid, NULL is returned.
*
* @param n the index number of the QualitativeSpecies to get.
*
* @return the nth QualitativeSpecies in the ListOfQualitativeSpecies.
*/
QualitativeSpecies* getQualitativeSpecies (unsigned int n);
/**
* Returns the qualitativeSpecies object based on its identifier.
*
* @param sid a string representing the identifier
* of the QualitativeSpecies to get.
*
* @return QualitativeSpecies in the ListOfQualitativeSpecies with the given id
* or NULL if no such QualitativeSpecies exists.
*
* @see getQualitativeSpecies(unsigned int n)
* @see getListOfQualitativeSpecies()
*/
QualitativeSpecies* getQualitativeSpecies (const std::string& sid);
/**
* Returns the qualitativeSpecies object based on its identifier.
*
* @param sid a string representing the identifier
* of the QualitativeSpecies to get.
*
* @return QualitativeSpecies in the ListOfQualitativeSpecies with the given id
* or NULL if no such QualitativeSpecies exists.
*
* @see getQualitativeSpecies(unsigned int n)
* @see getListOfQualitativeSpecies()
*/
const QualitativeSpecies* getQualitativeSpecies (const std::string& sid) const;
/**
* Adds a copy of the given QualitativeSpecies object to the list of qual.
*
* @param qualitativeSpecies the QualitativeSpecies object to be added to the list of qual.
*
* @return integer value indicating success/failure of the
* operation. The possible return values are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int addQualitativeSpecies (const QualitativeSpecies* qualitativeSpecies);
/**
* Creates a new qual object and adds it to the list of qual objects
* and returns it.
*
* @return a newly created QualitativeSpecies object
*/
QualitativeSpecies* createQualitativeSpecies();
/**
* Removes the nth QualitativeSpecies object from this plugin object and
* returns a pointer to it.
*
* The caller owns the returned object and is responsible for
* deleting it.
*
* @param n the index of the QualitativeSpecies object to remove
*
* @return the QualitativeSpecies object removed. As mentioned above, the
* caller owns the returned object. NULL is returned if the
* given index is out of range.
*/
QualitativeSpecies* removeQualitativeSpecies (unsigned int n);
/**
* Removes the QualitativeSpecies object with the given id attribute from
* this plugin object and returns a pointer to it.
*
* The caller owns the returned object and is responsible for
* deleting it.
*
* @param sid the id attribute of the QualitativeSpecies object to remove
*
* @return the QualitativeSpecies object removed. As mentioned above, the
* caller owns the returned object. NULL is returned if the
* given index is out of range.
*/
QualitativeSpecies* removeQualitativeSpecies (const std::string& sid);
/**
* Returns the number of QualitativeSpecies object in this plugin object.
*
* @return the number of QualitativeSpecies object in this plugin object.
*/
unsigned int getNumQualitativeSpecies() const;
/**
* Returns the ListOfTransitions in this plugin object.
*
* @return ListOfTransitions object in this plugin object.
*/
const ListOfTransitions* getListOfTransitions () const;
/**
* Returns the ListOfTransitions in this plugin object.
*
* @return ListOfTransitions object in this plugin object.
*/
ListOfTransitions* getListOfTransitions ();
/**
* Returns the Transition object that belongs to the given index. If the
* index is invalid, NULL is returned.
*
* @param n the index number of the Transition to get.
*
* @return the nth Transition in the ListOfTransitions.
*/
const Transition* getTransition (unsigned int n) const;
/**
* Returns the Transition object that belongs to the given index. If the
* index is invalid, NULL is returned.
*
* @param n the index number of the Transition to get.
*
* @return the nth Transition in the ListOfTransitions.
*/
Transition* getTransition (unsigned int n);
/**
* Returns the qualitativeSpecies object based on its identifier.
*
* @param sid a string representing the identifier
* of the Transition to get.
*
* @return Transition in the ListOfTransitions with the given id
* or NULL if no such Transition exists.
*
* @see getTransition(unsigned int n)
* @see getListOfTransitions()
*/
Transition* getTransition (const std::string& sid);
/**
* Returns the qualitativeSpecies object based on its identifier.
*
* @param sid a string representing the identifier
* of the Transition to get.
*
* @return Transition in the ListOfTransitions with the given id
* or NULL if no such Transition exists.
*
* @see getTransition(unsigned int n)
* @see getListOfTransitions()
*/
const Transition* getTransition (const std::string& sid) const;
/**
* Adds a copy of the given Transition object to the list of qual.
*
* @param transition the Transition object to be added to the list of qual.
*
* @return integer value indicating success/failure of the
* operation. The possible return values are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
*/
int addTransition (const Transition* transition);
/**
* Creates a new qual object and adds it to the list of qual objects
* and returns it.
*
* @return a newly created Transition object
*/
Transition* createTransition();
/**
* Removes the nth Transition object from this plugin object and
* returns a pointer to it.
*
* The caller owns the returned object and is responsible for
* deleting it.
*
* @param n the index of the Transition object to remove
*
* @return the Transition object removed. As mentioned above, the
* caller owns the returned object. NULL is returned if the
* given index is out of range.
*/
Transition* removeTransition (unsigned int n);
/**
* Removes the Transition object with the given id attribute from
* this plugin object and returns a pointer to it.
*
* The caller owns the returned object and is responsible for
* deleting it.
*
* @param sid the id attribute of the Transition object to remove
*
* @return the Transition object removed. As mentioned above, the
* caller owns the returned object. NULL is returned if the
* given index is out of range.
*/
Transition* removeTransition (const std::string& sid);
/**
* Returns the number of Transition object in this plugin object.
*
* @return the number of Transition object in this plugin object.
*/
unsigned int getNumTransitions() const;
// ---------------------------------------------------------
//
// virtual functions (internal implementation) which should
// be overridden by subclasses.
//
// ---------------------------------------------------------
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBMLDocument of this plugin object.
*
* Subclasses which contain one or more SBase derived elements must
* override this function.
*
* @param d the SBMLDocument object to use
*
* @see connectToParent
* @see enablePackageInternal
*/
virtual void setSBMLDocument (SBMLDocument* d);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the *parent* of this SBML object to child SBML objects (if any).
* (Creates a child-parent relationship by the parent)
*
* @see setSBMLDocument
* @see enablePackageInternal
*/
virtual void connectToChild ();
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBML object of this plugin object to
* this object and child elements (if any).
* (Creates a child-parent relationship by this plugin object)
*
* This function is called when this object is created by
* the parent element.
* Subclasses must override this this function if they have one
* or more child elements.Also, SBasePlugin::connectToParent()
* must be called in the overridden function.
*
* @param sbase the SBase object to use
*
* @see setSBMLDocument
* @see enablePackageInternal
*/
virtual void connectToParent (SBase *sbase);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Enables/Disables the given package with child elements in this plugin
* object (if any).
* (This is an internal implementation invoked from
* SBase::enablePackageInternal() function)
*
* @note Subclasses in which one or more SBase derived elements are
* defined must override this function.
*
* @see setSBMLDocument
* @see connectToParent
*/
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Accepts the given SBMLVisitor.
*/
virtual bool accept (SBMLVisitor& v) const;
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/*-- data members --*/
ListOfQualitativeSpecies mQualitativeSpecies;
ListOfTransitions mTransitions;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* QualModelPlugin_h */
|