/usr/include/sbml/packages/qual/extension/QualModelPlugin.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 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 | /**
* @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-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-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} Extension of Model.
*
* 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:
/**
* Creates a new QualModelPlugin 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.
*/
QualModelPlugin (const std::string &uri, const std::string &prefix,
QualPkgNamespaces *qualns);
/**
* Copy constructor. Creates a copy of this object.
*
* @param orig the instance to copy.
*/
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 QualModelPlugin 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 @c 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;
/** ------------------------------------------------------------------
*
* 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 @c 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 @c 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.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
*/
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 @c 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 @c 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.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
*/
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 */
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Gets the value of the "attributeName" attribute of this QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin's attribute
* "attributeName" is set.
*
* @param attributeName, the name of the attribute to query.
*
* @return @c true if this QualModelPlugin'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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @param elementName, the name of the element to create.
*
* @return pointer to the element created.
*/
virtual SBase* createChildObject(const std::string& elementName);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Adds a new "elementName" object to this QualModelPlugin.
*
* @param elementName, the name of the element to create.
*
* @param element, pointer to the element to be added.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
virtual int addChildObject(const std::string& elementName,
const SBase* element);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Removes and returns the new "elementName" object with the given id in this
* QualModelPlugin.
*
* @param elementName, the name of the element to remove.
*
* @param id, the id of the element to remove.
*
* @return pointer to the element removed.
*/
virtual SBase* removeChildObject(const std::string& elementName,
const std::string& id);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Returns the number of "elementName" in this QualModelPlugin.
*
* @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 QualModelPlugin.
*
* @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 */
/**
* Returns the first child element that has the given @p id in the model-wide
* SId namespace, or @c NULL if no such object is found.
*
* @param id a string representing the id attribute of the object to
* retrieve.
*
* @return a pointer to the SBase element with the given @p id.
*/
virtual SBase* getElementBySId(const std::string& id);
/**
* Returns the first child element that has the given @p metaid, or @c NULL
* if no such object is found.
*
* @param metaid a string representing the metaid attribute of the object to
* retrieve.
*
* @return a pointer to the SBase element with the given @p metaid.
*/
virtual SBase* getElementByMetaId(const std::string& metaid);
protected:
/** @cond doxygenLibsbmlInternal */
/*-- data members --*/
ListOfQualitativeSpecies mQualitativeSpecies;
ListOfTransitions mTransitions;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Returns a ListOf_t * containing QualitativeSpecies_t objects from this
* QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure whose ListOfQualitativeSpecies
* is sought.
*
* @return the ListOfQualitativeSpecies from this QualModelPlugin_t as a
* ListOf_t *.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
ListOf_t*
QualModelPlugin_getListOfQualitativeSpecies(QualModelPlugin_t* qmp);
/**
* Get a QualitativeSpecies_t from the QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param n an unsigned int representing the index of the QualitativeSpecies_t
* to retrieve.
*
* @return the nth QualitativeSpecies_t in the ListOfQualitativeSpecies within
* this QualModelPlugin.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
const QualitativeSpecies_t*
QualModelPlugin_getQualitativeSpecies(QualModelPlugin_t* qmp, unsigned int n);
/**
* Get a QualitativeSpecies_t from the QualModelPlugin_t based on its
* identifier.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param sid a string representing the identifier of the QualitativeSpecies_t
* to retrieve.
*
* @return the QualitativeSpecies_t in the ListOfQualitativeSpecies within this
* QualModelPlugin with the given id or @c NULL if no such QualitativeSpecies_t
* exists.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
const QualitativeSpecies_t*
QualModelPlugin_getQualitativeSpeciesById(QualModelPlugin_t* qmp,
const char *sid);
/**
* Get a QualitativeSpecies_t from the QualModelPlugin_t based on the
* Compartment to which it refers.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param sid a string representing the compartment attribute of the
* QualitativeSpecies_t object to retrieve.
*
* @return the first QualitativeSpecies_t in this QualModelPlugin_t based on
* the given compartment attribute or @c NULL if no such QualitativeSpecies_t
* exists.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
const QualitativeSpecies_t*
QualModelPlugin_getQualitativeSpeciesByCompartment(QualModelPlugin_t* qmp,
const char *sid);
/**
* Adds a copy of the given QualitativeSpecies_t to this QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to which the QualitativeSpecies_t
* should be added.
*
* @param qs the QualitativeSpecies_t object to add.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
int
QualModelPlugin_addQualitativeSpecies(QualModelPlugin_t* qmp,
const QualitativeSpecies_t* qs);
/**
* Get the number of QualitativeSpecies_t objects in this QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to query.
*
* @return the number of QualitativeSpecies_t objects in this
* QualModelPlugin_t.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
unsigned int
QualModelPlugin_getNumQualitativeSpecies(QualModelPlugin_t* qmp);
/**
* Creates a new QualitativeSpecies_t object, adds it to this QualModelPlugin_t
* object and returns the QualitativeSpecies_t object created.
*
* @param qmp the QualModelPlugin_t structure to which the QualitativeSpecies_t
* should be added.
*
* @return a new QualitativeSpecies_t object instance.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
QualitativeSpecies_t*
QualModelPlugin_createQualitativeSpecies(QualModelPlugin_t* qmp);
/**
* Removes the nth QualitativeSpecies_t from this QualModelPlugin_t and returns
* a pointer to it.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param n an unsigned int representing the index of the QualitativeSpecies_t
* to remove.
*
* @return a pointer to the nth QualitativeSpecies_t in this QualModelPlugin_t.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
QualitativeSpecies_t*
QualModelPlugin_removeQualitativeSpecies(QualModelPlugin_t* qmp,
unsigned int n);
/**
* Removes the QualitativeSpecies_t from this QualModelPlugin_t based on its
* identifier and returns a pointer to it.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param sid a string representing the identifier of the QualitativeSpecies_t
* to remove.
*
* @return the QualitativeSpecies_t in this QualModelPlugin_t based on the
* identifier or @c NULL if no such QualitativeSpecies_t exists.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
QualitativeSpecies_t*
QualModelPlugin_removeQualitativeSpeciesById(QualModelPlugin_t* qmp,
const char* sid);
/**
* Returns a ListOf_t * containing Transition_t objects from this
* QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure whose ListOfTransitions is
* sought.
*
* @return the ListOfTransitions from this QualModelPlugin_t as a ListOf_t *.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
ListOf_t*
QualModelPlugin_getListOfTransitions(QualModelPlugin_t* qmp);
/**
* Get a Transition_t from the QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param n an unsigned int representing the index of the Transition_t to
* retrieve.
*
* @return the nth Transition_t in the ListOfTransitions within this
* QualModelPlugin.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
const Transition_t*
QualModelPlugin_getTransition(QualModelPlugin_t* qmp, unsigned int n);
/**
* Get a Transition_t from the QualModelPlugin_t based on its identifier.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param sid a string representing the identifier of the Transition_t to
* retrieve.
*
* @return the Transition_t in the ListOfTransitions within this
* QualModelPlugin with the given id or @c NULL if no such Transition_t exists.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
const Transition_t*
QualModelPlugin_getTransitionById(QualModelPlugin_t* qmp, const char *sid);
/**
* Adds a copy of the given Transition_t to this QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to which the Transition_t should
* be added.
*
* @param t the Transition_t object to add.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
int
QualModelPlugin_addTransition(QualModelPlugin_t* qmp, const Transition_t* t);
/**
* Get the number of Transition_t objects in this QualModelPlugin_t.
*
* @param qmp the QualModelPlugin_t structure to query.
*
* @return the number of Transition_t objects in this QualModelPlugin_t.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
unsigned int
QualModelPlugin_getNumTransitions(QualModelPlugin_t* qmp);
/**
* Creates a new Transition_t object, adds it to this QualModelPlugin_t object
* and returns the Transition_t object created.
*
* @param qmp the QualModelPlugin_t structure to which the Transition_t should
* be added.
*
* @return a new Transition_t object instance.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
Transition_t*
QualModelPlugin_createTransition(QualModelPlugin_t* qmp);
/**
* Removes the nth Transition_t from this QualModelPlugin_t and returns a
* pointer to it.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param n an unsigned int representing the index of the Transition_t to
* remove.
*
* @return a pointer to the nth Transition_t in this QualModelPlugin_t.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
Transition_t*
QualModelPlugin_removeTransition(QualModelPlugin_t* qmp, unsigned int n);
/**
* Removes the Transition_t from this QualModelPlugin_t based on its identifier
* and returns a pointer to it.
*
* @param qmp the QualModelPlugin_t structure to search.
*
* @param sid a string representing the identifier of the Transition_t to
* remove.
*
* @return the Transition_t in this QualModelPlugin_t based on the identifier
* or @c NULL if no such Transition_t exists.
*
* @memberof QualModelPlugin_t
*/
LIBSBML_EXTERN
Transition_t*
QualModelPlugin_removeTransitionById(QualModelPlugin_t* qmp, const char* sid);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* !QualModelPlugin_H__ */
|