/usr/include/sbml/CompartmentType.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 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 | /**
* @file CompartmentType.h
* @brief Definitions of CompartmentType and ListOfCompartmentTypes.
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* 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 CompartmentType
* @sbmlbrief{core} Implementation of SBML's Level 2's %CompartmentType
* construct.
*
* SBML Level 2 Versions 2–4 provide the <em>compartment
* type</em> as a grouping construct that can be used to establish a
* relationship between multiple Compartment objects. A CompartmentType
* object only has an identity, and this identity can only be used to
* indicate that particular Compartment objects in the model belong to this
* type. This may be useful for conveying a modeling intention, such as
* when a model contains many similar compartments, either by their
* biological function or the reactions they carry. Without a compartment
* type construct, it would be impossible within SBML itself to indicate
* that all of the compartments share an underlying conceptual relationship
* because each SBML compartment must be given a unique and separate
* identity. Compartment types have no mathematical meaning in
* SBML—they have no effect on a model's mathematical interpretation.
* Simulators and other numerical analysis software may ignore
* CompartmentType definitions and references to them in a model.
*
* There is no mechanism in SBML Level 2 for representing hierarchies of
* compartment types. One CompartmentType instance cannot be the subtype
* of another CompartmentType instance; SBML provides no means of defining
* such relationships.
*
* As with other major structures in SBML, CompartmentType has a mandatory
* attribute, "id", used to give the compartment type an identifier. The
* identifier must be a text %string conforming to the identifer syntax
* permitted in SBML. CompartmentType also has an optional "name"
* attribute, of type @c string. The "id" and "name" must be used
* according to the guidelines described in the SBML specification (e.g.,
* Section 3.3 in the Level 2 Version 4 specification).
*
* CompartmentType was introduced in SBML Level 2 Version 2. It is not
* available in SBML Level 1 nor in Level 3.
*
* @see Compartment
* @see ListOfCompartmentTypes
* @see SpeciesType
* @see ListOfSpeciesTypes
*
*
* <!-- ------------------------------------------------------------------- -->
* @class ListOfCompartmentTypes
* @sbmlbrief{core} Implementation of SBML's %ListOfCompartmentTypes
* construct.
*
* @copydetails doc_what_is_listof
*/
/**
* <!-- ~ ~ ~ ~ ~ Start of common documentation strings ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
* The following text is used as common documentation blocks copied multiple
* times elsewhere in this file. The use of @class is a hack needed because
* Doxygen's @copydetails command has limited functionality. Symbols
* beginning with "doc_" are marked as ignored in our Doxygen configuration.
* ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ -->
*
* @class doc_compartmenttype_setting_lv
*
* @note Upon the addition of a CompartmentType object to an SBMLDocument (e.g.,
* using Model::addCompartmentType(@if java CompartmentType c@endif)), the SBML
* Level, SBML Version and XML namespace of the document @em override the
* values used when creating the CompartmentType object via the CompartmentType
* constructors. This is necessary to ensure that an SBML document has a
* consistent overall structure. Nevertheless, the ability to supply the
* values at the time of creation of a CompartmentType is an important aid to
* producing valid SBML. Knowledge of the intented SBML Level and Version
* determine whether it is valid to assign a particular value to an
* attribute, or whether it is valid to add an object to an existing
* SBMLDocument.
*
*/
#ifndef CompartmentType_h
#define CompartmentType_h
#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/SBase.h>
#include <sbml/ListOf.h>
#ifdef __cplusplus
#include <string>
LIBSBML_CPP_NAMESPACE_BEGIN
class SBMLVisitor;
class LIBSBML_EXTERN CompartmentType : public SBase
{
public:
/**
* Creates a new CompartmentType using the given SBML @p level and @p version
* values.
*
* @param level an unsigned int, the SBML Level to assign to this
* CompartmentType
*
* @param version an unsigned int, the SBML Version to assign to this
* CompartmentType
*
* @throws @if python ValueError @else SBMLConstructorException @endif@~
* Thrown if the given @p level and @p version combination, or this kind
* of SBML object, are either invalid or mismatched with respect to the
* parent SBMLDocument object.
*
* @copydetails doc_compartmenttype_setting_lv
*/
CompartmentType (unsigned int level, unsigned int version);
/**
* Creates a new CompartmentType using the given SBMLNamespaces object
* @p sbmlns.
*
* @copydetails doc_what_are_sbmlnamespaces
*
* It is worth emphasizing that although this constructor does not take an
* identifier argument, in SBML Level 2 and beyond, the "id"
* (identifier) attribute of a CompartmentType is required to have a value.
* Thus, callers are cautioned to assign a value after calling this
* constructor. Setting the identifier can be accomplished using the
* method setId(@if java String id@endif).
*
* @param sbmlns an SBMLNamespaces object.
*
* @throws @if python ValueError @else SBMLConstructorException @endif@~
* Thrown if the given @p level and @p version combination, or this kind
* of SBML object, are either invalid or mismatched with respect to the
* parent SBMLDocument object.
*
* @copydetails doc_compartmenttype_setting_lv
*/
CompartmentType (SBMLNamespaces* sbmlns);
/**
* Destroys this CompartmentType.
*/
virtual ~CompartmentType ();
/**
* Copy constructor; creates a copy of this CompartmentType.
*
* @param orig the object to copy.
*
* @throws @if python ValueError @else SBMLConstructorException @endif@~
* Thrown if the argument @p orig is @c NULL.
*/
CompartmentType(const CompartmentType& orig);
/**
* Assignment operator for CompartmentType.
*
* @param rhs The object whose values are used as the basis of the
* assignment.
*
* @throws @if python ValueError @else SBMLConstructorException @endif@~
* Thrown if the argument @p rhs is @c NULL.
*/
CompartmentType& operator=(const CompartmentType& rhs);
/**
* Accepts the given SBMLVisitor for this instance of CompartmentType.
*
* @param v the SBMLVisitor instance to be used.
*
* @return the result of calling <code>v.visit()</code>, which indicates
* whether the Visitor would like to visit the next CompartmentType in
* the list of compartment types.
*/
virtual bool accept (SBMLVisitor& v) const;
/**
* Creates and returns a deep copy of this CompartmentType.
*
* @return a (deep) copy of this CompartmentType.
*/
virtual CompartmentType* clone () const;
/**
* Returns the value of the "id" attribute of this CompartmentType.
*
* @return the id of this CompartmentType.
*/
virtual const std::string& getId () const;
/**
* Returns the value of the "name" attribute of this CompartmentType.
*
* @return the name of this CompartmentType.
*/
virtual const std::string& getName () const;
/**
* Predicate returning @c true if this
* CompartmentType's "id" attribute is set.
*
* @return @c true if the "id" attribute of this CompartmentType is
* set, @c false otherwise.
*/
virtual bool isSetId () const;
/**
* Predicate returning @c true if this
* CompartmentType's "name" attribute is set.
*
* @return @c true if the "name" attribute of this CompartmentType is
* set, @c false otherwise.
*/
virtual bool isSetName () const;
/**
* Sets the value of the "id" attribute of this CompartmentType.
*
* The string @p sid is copied.
*
* @copydetails doc_id_syntax
*
* @param sid the string to use as the identifier of this CompartmentType
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE @endlink
*/
virtual int setId (const std::string& sid);
/**
* Sets the value of the "name" attribute of this CompartmentType.
*
* The string in @p name is copied.
*
* @param name the new name for the CompartmentType
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE @endlink
*/
virtual int setName (const std::string& name);
/**
* Unsets the value of the "name" attribute of this CompartmentType.
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
*/
virtual int unsetName ();
/**
* Returns the libSBML type code for this SBML object.
*
* @copydetails doc_what_are_typecodes
*
* @return the SBML type code for this object:
* @link SBMLTypeCode_t#SBML_COMPARTMENT_TYPE SBML_COMPARTMENT_TYPE@endlink (default).
*
* @copydetails doc_warning_typecodes_not_unique
*
* @see getElementName()
* @see getPackageName()
*/
virtual int getTypeCode () const;
/**
* Returns the XML element name of this object, which for
* CompartmentType, is always @c "compartmentType".
*
* @return the name of this element, i.e., @c "compartmentType".
*/
virtual const std::string& getElementName () const;
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to write out their contained
* SBML objects as XML elements. Be sure to call your parents
* implementation of this method as well.
*/
virtual void writeElements (XMLOutputStream& stream) const;
/** @endcond */
/**
* Predicate returning @c true if
* all the required attributes for this CompartmentType object
* have been set.
*
* @note The required attributes for a CompartmentType object are:
* @li "id"
*
* @return a boolean value indicating whether all the required
* attributes for this object have been defined.
*/
virtual bool hasRequiredAttributes() const;
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Subclasses should override this method to get the list of
* expected attributes.
* This function is invoked from corresponding readAttributes()
* function.
*/
virtual void addExpectedAttributes(ExpectedAttributes& attributes);
/**
* Subclasses should override this method to read values from the given
* XMLAttributes set into their specific fields. Be sure to call your
* parents implementation of this method as well.
*
* @param attributes the XMLAttributes to use.
*/
virtual void readAttributes (const XMLAttributes& attributes,
const ExpectedAttributes& expectedAttributes);
void readL2Attributes (const XMLAttributes& attributes);
/**
* Subclasses should override this method to write their XML attributes
* to the XMLOutputStream. Be sure to call your parents implementation
* of this method as well.
*
* @param stream the XMLOutputStream to use.
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
std::string mId;
std::string mName;
/* the validator classes need to be friends to access the
* protected constructor that takes no arguments
*/
friend class Validator;
friend class ConsistencyValidator;
friend class IdentifierConsistencyValidator;
friend class InternalConsistencyValidator;
friend class L1CompatibilityValidator;
friend class L2v1CompatibilityValidator;
friend class L2v2CompatibilityValidator;
friend class L2v3CompatibilityValidator;
friend class L2v4CompatibilityValidator;
friend class MathMLConsistencyValidator;
friend class ModelingPracticeValidator;
friend class OverdeterminedValidator;
friend class SBOConsistencyValidator;
friend class UnitConsistencyValidator;
/** @endcond */
};
class LIBSBML_EXTERN ListOfCompartmentTypes : public ListOf
{
public:
/**
* Creates a new ListOfCompartmentTypes object.
*
* The object is constructed such that it is valid for the given SBML
* Level and Version combination.
*
* @param level the SBML Level
*
* @param version the Version within the SBML Level
*/
ListOfCompartmentTypes (unsigned int level, unsigned int version);
/**
* Creates a new ListOfCompartmentTypes object.
*
* The object is constructed such that it is valid for the SBML Level and
* Version combination determined by the SBMLNamespaces object in @p
* sbmlns.
*
* @param sbmlns an SBMLNamespaces object that is used to determine the
* characteristics of the ListOfCompartmentTypes object to be created.
*/
ListOfCompartmentTypes (SBMLNamespaces* sbmlns);
/**
* Creates and returns a deep copy of this ListOfCompartmentTypes instance.
*
* @return a (deep) copy of this ListOfCompartmentTypes.
*/
virtual ListOfCompartmentTypes* clone () const;
/**
* Returns the libSBML type code for the objects contained in this ListOf
* (i.e., CompartmentType objects, if the list is non-empty).
*
* @copydetails doc_what_are_typecodes
*
* @return the SBML type code for the objects contained in this ListOf
* instance: @link SBMLTypeCode_t#SBML_COMPARTMENT_TYPE SBML_COMPARTMENT_TYPE@endlink (default).
*
* @see getElementName()
* @see getPackageName()
*/
virtual int getItemTypeCode () const;
/**
* Returns the XML element name of this object.
*
* For ListOfCompartmentTypes, the XML element name is @c
* "listOfCompartmentTypes".
*
* @return the name of this element, i.e., @c "listOfCompartmentTypes".
*/
virtual const std::string& getElementName () const;
/**
* Get a CompartmentType from the ListOfCompartmentTypes.
*
* @param n the index number of the CompartmentType to get.
*
* @return the nth CompartmentType in this ListOfCompartmentTypes.
*
* @see size()
*/
virtual CompartmentType * get(unsigned int n);
/**
* Get a CompartmentType from the ListOfCompartmentTypes.
*
* @param n the index number of the CompartmentType to get.
*
* @return the nth CompartmentType in this ListOfCompartmentTypes.
*
* @see size()
*/
virtual const CompartmentType * get(unsigned int n) const;
/**
* Get a CompartmentType from the ListOfCompartmentTypes
* based on its identifier.
*
* @param sid a string representing the identifier
* of the CompartmentType to get.
*
* @return CompartmentType in this ListOfCompartmentTypes
* with the given @p sid or @c NULL if no such
* CompartmentType exists.
*
* @see get(unsigned int n)
* @see size()
*/
virtual CompartmentType* get (const std::string& sid);
/**
* Get a CompartmentType from the ListOfCompartmentTypes
* based on its identifier.
*
* @param sid a string representing the identifier
* of the CompartmentType to get.
*
* @return CompartmentType in this ListOfCompartmentTypes
* with the given @p sid or @c NULL if no such
* CompartmentType exists.
*
* @see get(unsigned int n)
* @see size()
*/
virtual const CompartmentType* get (const std::string& sid) const;
/**
* Removes the nth item from this ListOfCompartmentTypes items
* and returns a pointer to it.
*
* The caller owns the returned item and is responsible for deleting it.
*
* @param n the index of the item to remove
*
* @see size()
*/
virtual CompartmentType* remove (unsigned int n);
/**
* Removes item in this ListOfCompartmentTypes items with the given identifier.
*
* The caller owns the returned item and is responsible for deleting it.
* If none of the items in this list have the identifier @p sid, then @c
* NULL is returned.
*
* @param sid the identifier of the item to remove
*
* @return the item removed. As mentioned above, the caller owns the
* returned item.
*/
virtual CompartmentType* remove (const std::string& sid);
/** @cond doxygenLibsbmlInternal */
/**
* Get the ordinal position of this element in the containing object
* (which in this case is the Model object).
*
* The ordering of elements in the XML form of SBML is generally fixed
* for most components in SBML. For example, the
* ListOfCompartmentTypes in a model (in SBML Level 2 Version 4) is the
* third ListOf___. (However, it differs for different Levels and
* Versions of SBML, so calling code should not hardwire this number.)
*
* @return the ordinal position of the element with respect to its
* siblings, or @c -1 (default) to indicate the position is not significant.
*/
virtual int getElementPosition () const;
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Create a ListOfCompartmentTypes object corresponding to the next token
* in the XML input stream.
*
* @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 */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Creates a new CompartmentType_t structure using the given SBML @p level
* and @p version values.
*
* @param level an unsigned int, the SBML Level to assign to this
* CompartmentType_t
*
* @param version an unsigned int, the SBML Version to assign to this
* CompartmentType_t
*
* @return a pointer to the newly created CompartmentType_t structure.
*
* @note Once a CompartmentType_t has been added to an SBMLDocument_t, the @p
* level and @p version for the document @em override those used to create
* the CompartmentType_t. Despite this, the ability to supply the values at
* creation time is an important aid to creating valid SBML. Knowledge of
* the intended SBML Level and Version determine whether it is valid to
* assign a particular value to an attribute, or whether it is valid to add
* a structure to an existing SBMLDocument_t.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
CompartmentType_t *
CompartmentType_create (unsigned int level, unsigned int version);
/**
* Creates a new CompartmentType_t structure using the given
* SBMLNamespaces_t structure.
*
* @param sbmlns SBMLNamespaces_t, a pointer to an SBMLNamespaces_t structure
* to assign to this CompartmentType_t
*
* @return a pointer to the newly created CompartmentType_t structure.
*
* @note Once a CompartmentType_t has been added to an SBMLDocument_t, the
* @p sbmlns namespaces for the document @em override those used to create
* the CompartmentType_t. Despite this, the ability to supply the values at
* creation time is an important aid to creating valid SBML. Knowledge of the
* intended SBML Level and Version determine whether it is valid to assign a
* particular value to an attribute, or whether it is valid to add a structure
* to an existing SBMLDocument_t.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
CompartmentType_t *
CompartmentType_createWithNS (SBMLNamespaces_t *sbmlns);
/**
* Frees the given CompartmentType_t structure.
*
* @param ct the CompartmentType_t structure to be freed.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
void
CompartmentType_free (CompartmentType_t *ct);
/**
* Creates a deep copy of the given CompartmentType_t structure
*
* @param ct the CompartmentType_t structure to be copied
*
* @return a (deep) copy of this CompartmentType_t structure.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
CompartmentType_t *
CompartmentType_clone (const CompartmentType_t *ct);
/**
* Returns a list of XMLNamespaces_t associated with this CompartmentType_t
* structure.
*
* @param ct the CompartmentType_t structure
*
* @return pointer to the XMLNamespaces_t structure associated with
* this structure
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
const XMLNamespaces_t *
CompartmentType_getNamespaces(CompartmentType_t *ct);
/**
* Takes a CompartmentType_t structure and returns its identifier.
*
* @param ct the CompartmentType_t structure whose identifier is sought
*
* @return the identifier of this CompartmentType_t, as a pointer to a string.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
const char *
CompartmentType_getId (const CompartmentType_t *ct);
/**
* Takes a CompartmentType_t structure and returns its name.
*
* @param ct the CompartmentType_t whose name is sought.
*
* @return the name of this CompartmentType_t, as a pointer to a string.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
const char *
CompartmentType_getName (const CompartmentType_t *ct);
/**
* Predicate returning @c true or @c false depending on whether the given
* CompartmentType_t structure's identifier is set.
*
* @param ct the CompartmentType_t structure to query
*
* @return @c non-zero (true) if the "id" field of the given
* CompartmentType_t is set, zero (false) otherwise.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
int
CompartmentType_isSetId (const CompartmentType_t *ct);
/**
* Predicate returning @c true or @c false depending on whether the given
* CompartmentType_t structure's name is set.
*
* @param ct the CompartmentType_t structure to query
*
* @return @c non-zero (true) if the "name" field of the given
* CompartmentType_t is set, zero (false) otherwise.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
int
CompartmentType_isSetName (const CompartmentType_t *ct);
/**
* Assigns the identifier of a CompartmentType_t structure.
*
* This makes a copy of the string passed as the argument @p sid.
*
* @param ct the CompartmentType_t structure to set.
* @param sid the string to use as the identifier.
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE @endlink
*
* @note Using this function with an id of NULL is equivalent to
* unsetting the "id" attribute.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
int
CompartmentType_setId (CompartmentType_t *ct, const char *sid);
/**
* Assign the name of a CompartmentType_t structure.
*
* This makes a copy of the string passed as the argument @p name.
*
* @param ct the CompartmentType_t structure to set.
* @param name the string to use as the name.
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE @endlink
*
* @note Using this function with the name set to NULL is equivalent to
* unsetting the "name" attribute.
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
int
CompartmentType_setName (CompartmentType_t *ct, const char *name);
/**
* Unsets the name of a CompartmentType_t.
*
* @param ct the CompartmentType_t structure whose name is to be unset.
*
* @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_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
*
* @memberof CompartmentType_t
*/
LIBSBML_EXTERN
int
CompartmentType_unsetName (CompartmentType_t *ct);
/**
* Returns the CompartmentType_t structure having a given identifier.
*
* @param lo the ListOfCompartmentTypes_t structure to search.
* @param sid the "id" attribute value being sought.
*
* @return item in the @p lo ListOfCompartmentTypes with the given @p sid or a
* null pointer if no such item exists.
*
* @see ListOf_t
*
* @memberof ListOfCompartmentTypes_t
*/
LIBSBML_EXTERN
CompartmentType_t *
ListOfCompartmentTypes_getById (ListOf_t *lo, const char *sid);
/**
* Removes a CompartmentType_t structure based on its identifier.
*
* The caller owns the returned item and is responsible for deleting it.
*
* @param lo the list of CompartmentType_t structures to search.
* @param sid the "id" attribute value of the structure to remove
*
* @return The CompartmentType_t structure removed, or a null pointer if no such
* item exists in @p lo.
*
* @see ListOf_t
*
* @memberof ListOfCompartmentTypes_t
*/
LIBSBML_EXTERN
CompartmentType_t *
ListOfCompartmentTypes_removeById (ListOf_t *lo, const char *sid);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* CompartmentType_h */
|