/usr/include/sbml/packages/fbc/extension/FbcReactionPlugin.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 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 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 | /**
* @file FbcReactionPlugin.h
* @brief Implementation of the FbcReactionPlugin class
* @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-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 FbcReactionPlugin
* @sbmlbrief{fbc} Extension of Reaction by the “fbc” package.
*
* The FbcReactionPlugin class inherits from the SBasePlugin class, and
* codifies the extentions to the Reaction class defined in the @ref fbc
* package (“fbc”). This extention allows the modeler to define
* (in Version 2 of the “fbc” package) an upper and lower
* flux bound, with the 'upperFluxBound' and 'lowerFluxBound' attributes,
* as well as a way to reference any GeneProduct associated with
* this Reaction, through the GeneProductAssociation child.
*
* @note In Version 1 of “fbc”, the FluxBound element is
* used instead of the 'upperFluxBound' and 'lowerFluxBound' attributes.
* There is no equivalent of the GeneProductAssociation, which was added
* in Version 2.
*/
#ifndef FbcReactionPlugin_H__
#define FbcReactionPlugin_H__
#include <sbml/common/extern.h>
#ifdef __cplusplus
#include <sbml/extension/SBasePlugin.h>
#include <sbml/packages/fbc/sbml/GeneProductAssociation.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN FbcReactionPlugin : public SBasePlugin
{
public:
/**
* Creates a new FbcReactionPlugin 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 fbcns the namespaces object for the package.
*/
FbcReactionPlugin(const std::string& uri, const std::string& prefix,
FbcPkgNamespaces* fbcns);
/**
* Copy constructor for FbcReactionPlugin.
*
* @param orig the FbcReactionPlugin instance to copy.
*/
FbcReactionPlugin(const FbcReactionPlugin& orig);
/**
* Assignment operator for FbcReactionPlugin.
*
* @param rhs the object whose values are used as the basis
* of the assignment.
*/
FbcReactionPlugin& operator=(const FbcReactionPlugin& rhs);
/**
* Creates and returns a deep copy of this FbcReactionPlugin object.
*
* @return a (deep) copy of this FbcReactionPlugin object.
*/
virtual FbcReactionPlugin* clone () const;
/**
* Destructor for FbcReactionPlugin.
*/
virtual ~FbcReactionPlugin();
//---------------------------------------------------------------
//
// overridden virtual functions for read/write/check
//
//---------------------------------------------------------------
/** @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 @c NULL if the token was not recognized.
*/
virtual SBase* createObject (XMLInputStream& stream);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* 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;
/** @endcond */
//---------------------------------------------------------------
/** @cond doxygenLibsbmlInternal */
/**
* Get the list of expected attributes for this element.
*/
virtual void addExpectedAttributes(ExpectedAttributes& attributes);
/** @endcond */
/**
* @copydoc doc_renamesidref_common
*/
virtual void renameSIdRefs(const std::string& oldid, const std::string& newid);
/** @cond doxygenLibsbmlInternal */
/**
* Read values from the given XMLAttributes set into their specific fields.
*/
virtual void readAttributes (const XMLAttributes& attributes,
const ExpectedAttributes& expectedAttributes);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Write values of XMLAttributes to the output stream.
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
//---------------------------------------------------------------
//
// Functions for interacting with the members of the plugin
//
//---------------------------------------------------------------
/**
* Returns a List of all child SBase objects, including those nested to an
* arbitrary depth.
*
* @return a List of pointers to all child objects.
*/
virtual List* getAllElements(ElementFilter * filter = NULL);
/**
* Returns the GeneProductAssociation from this FbcReactionPlugin object.
*
* @copydetails doc_note_geneproduct_v2_only
*
* @return the GeneProductAssociation from object in this FbcReactionPlugin object.
*/
const GeneProductAssociation* getGeneProductAssociation () const;
/**
* Returns the GeneProductAssociation from this FbcReactionPlugin object.
*
* @copydetails doc_note_geneproduct_v2_only
*
* @return the GeneProductAssociation from object in this FbcReactionPlugin object.
*/
GeneProductAssociation* getGeneProductAssociation ();
/**
* Predicate returning @c true if this FbcReactionPlugin's
* "GeneProductAssociation" element has been set.
*
* @copydetails doc_note_geneproduct_v2_only
*
* @return @c true if the "GeneProductAssociation" element has been set,
* otherwise @c false is returned.
*/
bool isSetGeneProductAssociation() const;
/**
* Sets the GeneProductAssociation element in this FbcReactionPlugin object.
*
* @copydetails doc_note_geneproduct_v2_only
*
* @param geneProductAssociation the geneProductAssociation to be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
*/
int setGeneProductAssociation (const GeneProductAssociation* geneProductAssociation);
/**
* Creates a new GeneProductAssociation object and adds it to the FbcReactionPlugin object.
*
* @copydetails doc_note_geneproduct_v2_only
*
* @return the newly created GeneProductAssociation object.
*/
GeneProductAssociation* createGeneProductAssociation ();
/**
* Returns the value of the "lowerFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @return the value of the "lowerFluxBound" attribute of this FbcReactionPlugin as a string.
*/
virtual const std::string& getLowerFluxBound() const;
/**
* Returns the value of the "upperFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @return the value of the "upperFluxBound" attribute of this FbcReactionPlugin as a string.
*/
virtual const std::string& getUpperFluxBound() const;
/**
* Predicate returning @c true if this FbcReactionPlugin's "lowerFluxBound"
* attribute is set.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @return @c true if this FbcReactionPlugin's "lowerFluxBound" attribute has been set,
* otherwise @c false is returned.
*/
virtual bool isSetLowerFluxBound() const;
/**
* Predicate returning @c true if this FbcReactionPlugin's "upperFluxBound"
* attribute is set.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @return @c true if this FbcReactionPlugin's "upperFluxBound" attribute has been set,
* otherwise @c false is returned.
*/
virtual bool isSetUpperFluxBound() const;
/**
* Sets the value of the "lowerFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @param lowerFluxBound the value of the "lowerFluxBound" attribute to be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
virtual int setLowerFluxBound(const std::string& lowerFluxBound);
/**
* Sets the value of the "upperFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @param upperFluxBound the value of the "upperFluxBound" attribute to be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
virtual int setUpperFluxBound(const std::string& upperFluxBound);
/**
* Unsets the value of the "lowerFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int unsetLowerFluxBound();
/**
* Unsets the value of the "upperFluxBound" attribute of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int unsetUpperFluxBound();
/**
* Unsets the the "geneProduct" element of this FbcReactionPlugin.
*
* @copydetails doc_note_fluxbound_v2_only
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int unsetGeneProductAssociation();
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBMLDocument.
*/
virtual void setSBMLDocument (SBMLDocument* d);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
virtual void connectToParent (SBase* sbase);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin's attribute
* "attributeName" is set.
*
* @param attributeName, the name of the attribute to query.
*
* @return @c true if this FbcReactionPlugin'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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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 FbcReactionPlugin.
*
* @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
* FbcReactionPlugin.
*
* @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 */
/** @cond doxygenLibsbmlInternal */
/**
* Creates and returns an new "elementName" object in this FbcReactionPlugin.
*
* @param objectName, the name of the element to create.
*
* pointer to the object created.
*/
virtual SBase* createChildObject(const std::string& elementName);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Returns the number of "elementName" in this FbcReactionPlugin.
*
* @param elementName, the name of the element to get number of.
*
* @return unsigned int number of elements.
*/
virtual unsigned int getNumObjects(const std::string& elementName);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Returns the nth object of "objectName" in this FbcReactionPlugin.
*
* @param elementName, the name of the element to get number of.
*
* @param index, unsigned int the index of the object to retrieve.
*
* @return pointer to the object.
*/
virtual SBase* getObject(const std::string& elementName, unsigned int index);
/** @endcond */
#endif /* !SWIG */
/** @cond doxygenLibsbmlInternal */
virtual bool accept (SBMLVisitor& v) const;
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
GeneProductAssociation* mGeneProductAssociation;
std::string mLowerFluxBound;
std::string mUpperFluxBound;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Takes a FbcReactionPlugin_t structure and returns its "upperFluxBound" attribute.
*
* @param fbc the FbcReactionPlugin_t whose "upperFluxBound" attribute is sought.
*
* @return the "upperFluxBound" attribute of the given FbcReactionPlugin_t, as a pointer to a string.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
char *
FbcReactionPlugin_getUpperFluxBound(SBasePlugin_t * fbc);
/**
* Predicate returning @c 1 (true) or @c 0 (false) depending on whether the given
* FbcReactionPlugin_t structure's "upperFluxBound" attribute is set.
*
* @param fbc the FbcReactionPlugin_t structure to query.
*
* @return @c 1 (true) if the "upperFluxBound" attribute of the given
* FbcReactionPlugin_t structure is set, @c 0 (false) otherwise.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_isSetUpperFluxBound(SBasePlugin_t * fbc);
/**
* Sets the "upperFluxBound" attribute of the given FbcReactionPlugin_t to a copy of @p UpperFluxBound.
*
* @param fbc the FbcReactionPlugin_t structure to set.
* @param UpperFluxBound the string to assign to the given FbcReactionPlugin_t's "upperFluxBound" attribute.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*
* @note Using this function with the name set to NULL is equivalent to
* unsetting the "upperFluxBound" attribute.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_setUpperFluxBound(SBasePlugin_t * fbc, const char * UpperFluxBound);
/**
* Unsets the "upperFluxBound" attribute of the given FbcReactionPlugin_t structure.
*
* @param fbc the FbcReactionPlugin_t structure to unset.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_unsetUpperFluxBound(SBasePlugin_t * fbc);
/**
* Takes a FbcReactionPlugin_t structure and returns its "lowerFluxBound" attribute.
*
* @param fbc the FbcReactionPlugin_t whose "lowerFluxBound" attribute is sought.
*
* @return the "lowerFluxBound" attribute of the given FbcReactionPlugin_t, as a pointer to a string.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
char *
FbcReactionPlugin_getLowerFluxBound(SBasePlugin_t * fbc);
/**
* Predicate returning @c 1 (true) or @c 0 (false) depending on whether the given
* FbcReactionPlugin_t structure's "lowerFluxBound" attribute is set.
*
* @param fbc the FbcReactionPlugin_t structure to query.
*
* @return @c 1 (true) if the "lowerFluxBound" attribute attribute of the given
* FbcReactionPlugin_t structure is set, @c 0 (false) otherwise.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_isSetLowerFluxBound(SBasePlugin_t * fbc);
/**
* Sets the "lowerFluxBound" attribute of the given FbcReactionPlugin_t to a copy of @p LowerFluxBound.
*
* @param fbc the FbcReactionPlugin_t structure to set.
* @param LowerFluxBound the string to assign to the given FbcReactionPlugin_t's "lowerFluxBound" attribute.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*
* @note Using this function with the name set to NULL is equivalent to
* unsetting the "lowerFluxBound" attribute.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_setLowerFluxBound(SBasePlugin_t * fbc, const char * LowerFluxBound);
/**
* Unsets the "upperFluxBound" attribute of the given FbcReactionPlugin_t structure.
*
* @param fbc the FbcReactionPlugin_t structure to unset.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_unsetUpperFluxBound(SBasePlugin_t * fbc);
/**
* Predicate returning @c 1 (true) or @c 0 (false) depending on whether the given
* FbcReactionPlugin_t structure's GeneProductAssociation is set.
*
* @param fbc the FbcReactionPlugin_t structure to query.
*
* @return @c 1 (true) if the "geneProductAssopciation" elemen of the given
* FbcReactionPlugin_t structure is set, @c 0 (false) otherwise.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_isSetGeneProductAssociation(SBasePlugin_t * fbc);
/**
* Takes a FbcReactionPlugin_t structure and returns its GeneProductAssociation_t.
*
* @param fbc the FbcReactionPlugin_t whose GeneProductAssociation_t is sought.
*
* @return the a pointer to the GeneProductAssociation_t of the given FbcReactionPlugin_t.
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
GeneProductAssociation_t*
FbcReactionPlugin_getGeneProductAssociation(SBasePlugin_t * fbc);
/**
* Takes a FbcReactionPlugin_t structure and sets its GeneProductAssociation_t.
*
* @param fbc the FbcReactionPlugin_t whose GeneProductAssociation_t is sought.
* @param gpa a pointer to the GeneProductAssociation_t to be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @memberof FbcReactionPlugin_t
*/
LIBSBML_EXTERN
int
FbcReactionPlugin_setGeneProductAssociation(SBasePlugin_t * fbc,
GeneProductAssociation_t* gpa);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* FbcReactionPlugin_H__ */
|