/usr/include/sbml/packages/render/sbml/GlobalRenderInformation.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 | /**
* @file GlobalRenderInformation.h
* @brief class for representing global render information
* @author Ralph Gauges
* @author Frank T. Bergmann
*
* <!--------------------------------------------------------------------------
* 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) 2011-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright 2010 Ralph Gauges
* Group for the modeling of biological processes
* University of Heidelberg
* Im Neuenheimer Feld 267
* 69120 Heidelberg
* Germany
*
* 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 GlobalRenderInformation
* @brief GlobalRenderInformation is the render information stored in the ListOfLayouts. GlobalRenderInformation can be
* applied to all layouts.
*
* GlobalRenderInformation is one of the subclasses of RenderInformationBase. A global render information object
* contains color definitions, gradient definitions and line endings as defined in RenderInformationBase.
* Additionally it has a list of global styles which specifies type and role based render information.
* Global render information can not specify id based render information because it does not belong to a certain layout
* but it belongs to all layouts.
*
* @class ListOfGlobalRenderInformation
* @brief container class that stores GlobalRenderInformation objects.
*
* The ListOfLayouts in the SBML model contains a ListOfGlobalRenderInformation which holds all GlobalRenderInformation
* objects.
*/
#ifndef GlobalRenderInformation_H__
#define GlobalRenderInformation_H__
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/render/sbml/RenderInformationBase.h>
#include <sbml/packages/render/sbml/GlobalStyle.h>
#include <sbml/xml/XMLNode.h>
#ifdef __cplusplus
#include <string>
#include <sbml/packages/render/extension/RenderExtension.h>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN GlobalRenderInformation : public RenderInformationBase
{
protected:
/** @cond doxygenLibsbmlInternal */
ListOfGlobalStyles mListOfStyles;
static const std::string ELEMENT_NAME;
/** @endcond */
public:
/**
* Creates a new GlobalRenderInformation object with the given SBML level
* and SBML version.
*
* @param level SBML level of the new object
* @param level SBML version of the new object
*/
GlobalRenderInformation (unsigned int level = RenderExtension::getDefaultLevel(),
unsigned int version = RenderExtension::getDefaultVersion(),
unsigned int pkgVersion = RenderExtension::getDefaultPackageVersion());
/**
* Creates a new GlobalRenderInformation object with the given SBMLNamespaces.
*
* @param sbmlns The SBML namespace for the object.
*/
GlobalRenderInformation (RenderPkgNamespaces* renderns);
/**
* Destroy this GlobalRenderInformation object.
*/
virtual ~GlobalRenderInformation ();
/**
* Parses the xml information in the given node and sets the attributes.
* This method should never be called by the user. It is only used to read render
* information from annotations.
*
* @param node the XMLNode object reference that describes the GlobalRenderInformation
* object to be instantiated.
*/
void parseXML(const XMLNode& node);
#ifndef OMIT_DEPRECATED
/**
* Constructor which creates a GlobalRenderInformation with the given @p id
* and all lists empty.
*
* @param id the new id for the GlobalRenderInformation.
*
* This constructor is deprecated. The new libsbml API only has
* constructors which take the SBML level and version or one that takes
* an SBMLNamespaces object.
*/
GlobalRenderInformation(RenderPkgNamespaces* renderns, const std::string& id);
#endif // OMIT_DEPRECATED
/**
* Returns the number of styles.
*
* @return the number of global styles in the global render information object
*/
unsigned int getNumStyles() const;
/**
* Returns a pointer to the ListOfGlobalStyles object.
*
* @return pointer to the list of global styles.
*/
ListOfGlobalStyles* getListOfStyles();
/**
* Returns a const pointer to the ListOfGlobalStyles object.
*
* @return const pointer to the list of global styles.
*/
const ListOfGlobalStyles* getListOfStyles() const;
/**
* Returns a pointer to the style with the given index.
* If the index is invalid, @c NULL is returned.
*
* @param i index of the GlobalStyle to be returned.
*
* @return pointer to the style with the given index or NULL
*/
GlobalStyle* getStyle(unsigned int i);
/**
* Returns a const pointer to the style with the given index.
* If the index is invalid, @c NULL is returned.
*
* @param i index of the GlobalStyle to be returned.
*
* @return const pointer to the style with the given index or NULL
*/
const GlobalStyle* getStyle(unsigned int i) const;
/**
* Returns a pointer to the style with the given @p id.
* If the id is invalid, @c NULL is returned.
*
* @param id id of the GlobalStyle to be returned.
*
* @return pointer to the style with the given @p id or @c NULL
*/
GlobalStyle* getStyle(const std::string& id);
/**
* Returns a pointer to the style with the given @p id.
* If the id is invalid, @c NULL is returned.
*
* @param id id of the GlobalStyle to be returned.
*
* @return const pointer to the style with the given @p id or @c NULL
*/
const GlobalStyle* getStyle(const std::string& id) const;
/**
* Creates a new GlobalStyle object. The object is added to and owned
* by the GlobalRenderInformation object.
*
* @param id for the new style.
*
* @ return a pointer to the newly created GlobalStyle object.
*/
GlobalStyle* createStyle(const std::string& id);
/**
* Adds a copy of a GlobalStyle to the GlobalRenderInformation object.
* The style is only added if it is valid, i.e. it has to have an id and
* a valid group.
*
* @param pointer to the global style object to be added.
*
* @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 LIBSBML_OPERATION_SUCCESS
* @li LIBSBML_LEVEL_MISMATCH
* @li LIBSBML_VERSION_MISMATCH
* @li LIBSBML_OPERATION_FAILED
*
* @note This method should be used with some caution. The fact that
* this method @em copies the object passed to it means that the caller
* will be left holding a physically different object instance than the
* one contained in this GlobalRenderInformation. Changes made to the original object
* instance (such as resetting attribute values) will <em>not affect the
* instance in the GlobalRenderInformation</em>. In addition, the caller should make
* sure to free the original object if it is no longer being used, or
* else a memory leak will result. Please see GlobalRenderInformation::createStyle()
* for a method that does not lead to these issues.
*
* @see createStyle()
*/
int addStyle(const GlobalStyle* pStyle);
/**
* Returns a List of all child SBase objects, including those nested to an
* arbitrary depth
*
* @return a List* of pointers to all children objects.
*/
virtual List* getAllElements(ElementFilter* filter=NULL);
/** @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. For example:
*
* SBase::writeElements(stream);
* mReactants.write(stream);
* mProducts.write(stream);
* ...
*/
virtual void writeElements (XMLOutputStream& stream) const;
/** @endcond */
/**
* Returns the XML element name of this object, which for
* GlobalRenderInformation, is always @c "renderInformation".
*
* @return the name of this element, i.e., @c "renderInformation".
*/
virtual const std::string& getElementName () const ;
/**
* Creates and returns a deep copy of this GlobalRenderInformation object.
*
* @return a (deep) copy of this GlobalRenderInformation.
*/
virtual GlobalRenderInformation* clone () const;
/**
* Returns the libSBML type code for this %SBML object.
*
* @if clike LibSBML attaches an identifying code to every
* kind of SBML object. These are known as <em>SBML type codes</em>.
* The set of possible type codes is defined in the enumeration
* #SBMLTypeCode_t. The names of the type codes all begin with the
* characters @c SBML_. @endif@if java LibSBML attaches an
* identifying code to every kind of SBML object. These are known as
* <em>SBML type codes</em>. In other languages, the set of type codes
* is stored in an enumeration; in the Java language interface for
* libSBML, the type codes are defined as static integer constants in
* interface class {@link libsbmlConstants}. The names of the type codes
* all begin with the characters @c SBML_. @endif
*
* @return the SBML type code for this object, or @c SBML_UNKNOWN (default).
*
* @see getElementName()
*/
int getTypeCode () const;
/**
* Accepts the given SBMLVisitor.
*
* @return the result of calling <code>v.visit()</code>, which indicates
* whether or not the Visitor would like to visit the SBML object's next
* sibling object (if available).
*/
virtual bool accept (SBMLVisitor& v) const;
/**
* Creates an XMLNode object from this GlobalRenderInformation object.
*
* @return the XMLNode with the XML representation for the
* GlobalRenderInformation object.
*
*/
XMLNode toXML() const;
/** @cond doxygenLibsbmlInternal */
/**
* Sets the parent SBMLDocument of this SBML object.
*
* @param d the SBMLDocument object to use
*/
virtual void setSBMLDocument (SBMLDocument* d);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Sets this SBML object to child SBML objects (if any).
* (Creates a child-parent relationship by the parent)
*
* Subclasses must override this function if they define
* one ore more child elements.
* Basically, this function needs to be called in
* constructor, copy constructor, assignment operator.
*
* @see setSBMLDocument
* @see enablePackageInternal
*/
virtual void connectToChild ();
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Enables/Disables the given package with this element and child
* elements (if any).
* (This is an internal implementation for enablePakcage function)
*
* @note Subclasses in which one or more child elements are defined
* must override this function.
*/
virtual void enablePackageInternal(const std::string& pkgURI,
const std::string& pkgPrefix, bool flag);
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* @return the SBML object corresponding to next XMLToken in the
* XMLInputStream or NULL if the token was not recognized.
*/
virtual SBase* createObject (XMLInputStream& stream);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* 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.
*/
virtual void readAttributes (const XMLAttributes& attributes, const ExpectedAttributes& expectedAttributes);
/** @endcond */
/** @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);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* 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. For example:
*
* SBase::writeAttributes(stream);
* stream.writeAttribute( "id" , mId );
* stream.writeAttribute( "name", mName );
* ...
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
};
class DefaultValues;
class LIBSBML_EXTERN ListOfGlobalRenderInformation : public ListOf
{
public:
/**
* Creates and returns a deep copy of the ListOfGlobalRenderInformation object.
*
* @return a (deep) copy of this ListOfGlobalRenderInformation
*/
virtual ListOfGlobalRenderInformation* clone () const;
/**
* Parses the xml information in the given node and sets the attributes.
* This method should never be called by the user. It is only used to read render
* information from annotations.
*
* @param node the XMLNode object reference that describes the ListOfGlobalRenderInformation
* object to be instantiated.
*/
void parseXML(const XMLNode& node);
/**
* Constructor which instantiates an empty ListOfGlobalRenderInformation object.
*/
ListOfGlobalRenderInformation(unsigned int level = RenderExtension::getDefaultLevel(),
unsigned int version = RenderExtension::getDefaultVersion(),
unsigned int pkgVersion = RenderExtension::getDefaultPackageVersion());
virtual ~ListOfGlobalRenderInformation();
/**
* Ctor.
*/
ListOfGlobalRenderInformation(RenderPkgNamespaces* renderns);
/**
* Copy constructor for ListOfGlobalRenderInformation objects.
*/
ListOfGlobalRenderInformation(const ListOfGlobalRenderInformation& source);
/**
* Assignment operator for ListOfGlobalRenderInformationObjects.
*/
ListOfGlobalRenderInformation& operator=(const ListOfGlobalRenderInformation& source);
/**
* Get the type code of the objects contained in this ListOf.
*
* @if clike LibSBML attaches an identifying code to every kind of SBML
* object. These are known as <em>SBML type codes</em>. The set of
* possible type codes is defined in the enumeration #SBMLTypeCode_t.
* The names of the type codes all begin with the characters @c
* SBML_. @endif@if java LibSBML attaches an identifying code to every
* kind of SBML object. These are known as <em>SBML type codes</em>. In
* other languages, the set of type codes is stored in an enumeration; in
* the Java language interface for libSBML, the type codes are defined as
* static integer constants in the interface class {@link
* libsbmlConstants}. The names of the type codes all begin with the
* characters @c SBML_. @endif@if python LibSBML attaches an identifying
* code to every kind of SBML object. These are known as <em>SBML type
* codes</em>. In the Python language interface for libSBML, the type
* codes are defined as static integer constants in the interface class
* @link libsbml@endlink. The names of the type codes all begin with the
* characters @c SBML_. @endif@if csharp LibSBML attaches an identifying
* code to every kind of SBML object. These are known as <em>SBML type
* codes</em>. In the C# language interface for libSBML, the type codes
* are defined as static integer constants in the interface class @link
* libsbmlcs.libsbml@endlink. The names of the type codes all begin with
* the characters @c SBML_. @endif
*
* @return the SBML type code for the objects contained in this ListOf
* instance, or @link SBMLTypeCode_t#SBML_UNKNOWN SBML_UNKNOWN@endlink (default).
*/
virtual int getItemTypeCode () const;
virtual bool isValidTypeForList(SBase * item);
/**
* Returns the XML element name of this object, which for
* ListOfGlobalRenderInformation, is always @c "listOfGlobalRenderInformation".
*
* @return the name of this element, i.e., @c "listOfGlobalRenderInformation".
*/
virtual const std::string& getElementName () const;
/**
* Creates an XMLNode object from this ListOfGlobalRenderInformation object.
*
* @return the XMLNode with the XML representation for the
* ListOfGlobalRenderInformation object.
*/
XMLNode toXML() const;
/**
* Sets the version of the render information list.
* The version consists of a major and a minor version number.
*
* @param major major version number
* @param minor minor version number
*/
void setVersion(unsigned int major,unsigned int minor);
/**
* Returns the major version of the render information list.
*
* @return the major version number of the global render information list
*/
unsigned int getMajorVersion() const;
/**
* Returns the minor version of the render information list.
*
* @return the minor version number of the global render information list
*/
unsigned int getMinorVersion() const;
/**
* Predicate returning @c true if this ListOfGlobalRenderInformation's
* "versionMajor" attribute is set.
*
* @return @c true if this ListOfGlobalRenderInformation's "versionMajor"
* attribute has been set, otherwise @c false is returned.
*/
bool isSetVersionMajor() const;
/**
* Predicate returning @c true if this ListOfGlobalRenderInformation's
* "versionMinor" attribute is set.
*
* @return @c true if this ListOfGlobalRenderInformation's "versionMinor"
* attribute has been set, otherwise @c false is returned.
*/
bool isSetVersionMinor() const;
/**
* Unsets the value of the "versionMajor" attribute of this
* ListOfGlobalRenderInformation.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetVersionMajor();
/**
* Unsets the value of the "versionMinor" attribute of this
* ListOfGlobalRenderInformation.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetVersionMinor();
/**
* Sets the value of the "versionMajor" attribute of this
* ListOfGlobalRenderInformation.
*
* @param versionMajor unsigned int value of the "versionMajor" attribute to
* be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
* OperationReturnValues_t}
*/
int setVersionMajor(unsigned int versionMajor);
/**
* Sets the value of the "versionMinor" attribute of this
* ListOfGlobalRenderInformation.
*
* @param versionMinor unsigned int value of the "versionMinor" attribute to
* be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
* OperationReturnValues_t}
*/
int setVersionMinor(unsigned int versionMinor);
/**
* Returns the version as a string.
*
* @return the version of the GlobalRenderInformation object
* as a string
*/
std::string getVersionString() const;
/**
* Returns a pointer to the GlobalRenderInformation with the given index or NULL if
* the index is invalid.
*
* @param i index of the GlobalRenderInformation object to be returned
*
* @return pointer to the GlobalRenderInformation at the given index or NULL.
*/
GlobalRenderInformation* get(unsigned int i);
/**
* Returns a const pointer to the GlobalRenderInformation with the given index or NULL if
* the index is invalid.
*
* @param i index of the GlobalRenderInformation object to be returned
*
* @return const pointer to the GlobalRenderInformation at the given index or NULL.
*/
const GlobalRenderInformation* get(unsigned int i) const;
/**
* Returns a pointer to the GlobalRenderInformation with the given @p id or @c NULL if
* the id is invalid.
*
* @param id id of the GlobalRenderInformation object to be returned
*
* @return pointer to the GlobalRenderInformation at the given @p id or @c NULL.
*/
GlobalRenderInformation* get(const std::string& id);
/**
* Returns a const pointer to the GlobalRenderInformation with the given @p id or @c NULL if
* the id is invalid.
*
* @param id id of the GlobalRenderInformation object to be returned
*
* @return const pointer to the GlobalRenderInformation at the given @p id or @c NULL.
*/
const GlobalRenderInformation* get(const std::string& id) const;
/**
* Removes the nth item from this ListOfGlobalRenderInformation 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 GlobalRenderInformation* remove (unsigned int n);
/**
* Removes item in this ListOfGlobalRenderInformation 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 GlobalRenderInformation* remove (const std::string& sid);
/**
* Returns the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation.
*
* @return the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation as a DefaultValues*.
*/
const DefaultValues* getDefaultValues() const;
/**
* Returns the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation.
*
* @return the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation as a DefaultValues*.
*/
DefaultValues* getDefaultValues();
/**
* Predicate returning @c true if this ListOfGlobalRenderInformation's
* "defaultValues" element is set.
*
* @return @c true if this ListOfGlobalRenderInformation's "defaultValues"
* element has been set, otherwise @c false is returned.
*/
bool isSetDefaultValues() const;
/**
* Sets the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation.
*
* @param defaultValues DefaultValues* value of the "defaultValues" element
* to be set.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
* OperationReturnValues_t}
*/
int setDefaultValues(const DefaultValues* defaultValues);
/**
* Creates a new DefaultValues object, adds it to this
* ListOfGlobalRenderInformation object and returns the DefaultValues object
* created.
*
* @return a new DefaultValues object instance.
*/
DefaultValues* createDefaultValues();
/**
* Unsets the value of the "defaultValues" element of this
* ListOfGlobalRenderInformation.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetDefaultValues();
/** @cond doxygenLibsbmlInternal */
/**
* Write any contained elements
*/
virtual void writeElements(XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
* Connects to child elements
*/
virtual void connectToChild();
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* @return the SBML object corresponding to next XMLToken in the
* XMLInputStream or NULL if the token was not recognized.
*/
virtual SBase* createObject (XMLInputStream& stream);
/** @endcond */
/** @cond doxygenLibsbmlInternal */
virtual void addExpectedAttributes(ExpectedAttributes& 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. For example:
*
* SBase::writeAttributes(stream);
* stream.writeAttribute( "id" , mId );
* stream.writeAttribute( "name", mName );
* ...
*/
virtual void writeAttributes (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
/**
*
* Subclasses should override this method to write their xmlns attriubutes
* (if any) to the XMLOutputStream.
*
*/
virtual void writeXMLNS (XMLOutputStream& stream) const;
/** @endcond */
/** @cond doxygenLibsbmlInternal */
static const std::string ELEMENT_NAME;
unsigned int mVersionMajor;
bool mIsSetVersionMajor;
unsigned int mVersionMinor;
bool mIsSetVersionMinor;
DefaultValues* mDefaultValues;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#endif /* GlobalRenderInformation_H__ */
|