1 /** 2 * @file CSGTranslation.h 3 * @brief Definition of the CSGTranslation class. 4 * @author SBMLTeam 5 * 6 * <!-------------------------------------------------------------------------- 7 * This file is part of libSBML. Please visit http://sbml.org for more 8 * information about SBML, and the latest version of libSBML. 9 * 10 * Copyright (C) 2020 jointly by the following organizations: 11 * 1. California Institute of Technology, Pasadena, CA, USA 12 * 2. University of Heidelberg, Heidelberg, Germany 13 * 3. University College London, London, UK 14 * 15 * Copyright (C) 2019 jointly by the following organizations: 16 * 1. California Institute of Technology, Pasadena, CA, USA 17 * 2. University of Heidelberg, Heidelberg, Germany 18 * 19 * Copyright (C) 2013-2018 jointly by the following organizations: 20 * 1. California Institute of Technology, Pasadena, CA, USA 21 * 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK 22 * 3. University of Heidelberg, Heidelberg, Germany 23 * 24 * Copyright (C) 2009-2013 jointly by the following organizations: 25 * 1. California Institute of Technology, Pasadena, CA, USA 26 * 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK 27 * 28 * Copyright (C) 2006-2008 by the California Institute of Technology, 29 * Pasadena, CA, USA 30 * 31 * Copyright (C) 2002-2005 jointly by the following organizations: 32 * 1. California Institute of Technology, Pasadena, CA, USA 33 * 2. Japan Science and Technology Agency, Japan 34 * 35 * This library is free software; you can redistribute it and/or modify it 36 * under the terms of the GNU Lesser General Public License as published by the 37 * Free Software Foundation. A copy of the license agreement is provided in the 38 * file named "LICENSE.txt" included with this software distribution and also 39 * available online as http://sbml.org/software/libsbml/license.html 40 * ------------------------------------------------------------------------ --> 41 * 42 * @class CSGTranslation 43 * @sbmlbrief{spatial} TODO:Definition of the CSGTranslation class. 44 */ 45 46 47 #ifndef CSGTranslation_H__ 48 #define CSGTranslation_H__ 49 50 51 #include <sbml/common/extern.h> 52 #include <sbml/common/sbmlfwd.h> 53 #include <sbml/packages/spatial/common/spatialfwd.h> 54 55 56 #ifdef __cplusplus 57 58 59 #include <string> 60 61 62 #include <sbml/packages/spatial/sbml/CSGTransformation.h> 63 #include <sbml/packages/spatial/extension/SpatialExtension.h> 64 65 66 LIBSBML_CPP_NAMESPACE_BEGIN 67 68 69 class LIBSBML_EXTERN CSGTranslation : public CSGTransformation 70 { 71 protected: 72 73 /** @cond doxygenLibsbmlInternal */ 74 75 double mTranslateX; 76 bool mIsSetTranslateX; 77 double mTranslateY; 78 bool mIsSetTranslateY; 79 double mTranslateZ; 80 bool mIsSetTranslateZ; 81 82 /** @endcond */ 83 84 public: 85 86 /** 87 * Creates a new CSGTranslation using the given SBML Level, Version and 88 * “spatial” package version. 89 * 90 * @param level an unsigned int, the SBML Level to assign to this 91 * CSGTranslation. 92 * 93 * @param version an unsigned int, the SBML Version to assign to this 94 * CSGTranslation. 95 * 96 * @param pkgVersion an unsigned int, the SBML Spatial Version to assign to 97 * this CSGTranslation. 98 * 99 * @copydetails doc_note_setting_lv_pkg 100 */ 101 CSGTranslation(unsigned int level = SpatialExtension::getDefaultLevel(), 102 unsigned int version = SpatialExtension::getDefaultVersion(), 103 unsigned int pkgVersion = 104 SpatialExtension::getDefaultPackageVersion()); 105 106 107 /** 108 * Creates a new CSGTranslation using the given SpatialPkgNamespaces object. 109 * 110 * @copydetails doc_what_are_sbml_package_namespaces 111 * 112 * @param spatialns the SpatialPkgNamespaces object. 113 * 114 * @copydetails doc_note_setting_lv_pkg 115 */ 116 CSGTranslation(SpatialPkgNamespaces *spatialns); 117 118 119 /** 120 * Copy constructor for CSGTranslation. 121 * 122 * @param orig the CSGTranslation instance to copy. 123 */ 124 CSGTranslation(const CSGTranslation& orig); 125 126 127 /** 128 * Assignment operator for CSGTranslation. 129 * 130 * @param rhs the CSGTranslation object whose values are to be used as the 131 * basis of the assignment. 132 */ 133 CSGTranslation& operator=(const CSGTranslation& rhs); 134 135 136 /** 137 * Creates and returns a deep copy of this CSGTranslation object. 138 * 139 * @return a (deep) copy of this CSGTranslation object. 140 */ 141 virtual CSGTranslation* clone() const; 142 143 144 /** 145 * Destructor for CSGTranslation. 146 */ 147 virtual ~CSGTranslation(); 148 149 150 /** 151 * Returns the value of the "translateX" attribute of this CSGTranslation. 152 * 153 * @return the value of the "translateX" attribute of this CSGTranslation as 154 * a double. 155 */ 156 double getTranslateX() const; 157 158 159 /** 160 * Returns the value of the "translateY" attribute of this CSGTranslation. 161 * 162 * @return the value of the "translateY" attribute of this CSGTranslation as 163 * a double. 164 */ 165 double getTranslateY() const; 166 167 168 /** 169 * Returns the value of the "translateZ" attribute of this CSGTranslation. 170 * 171 * @return the value of the "translateZ" attribute of this CSGTranslation as 172 * a double. 173 */ 174 double getTranslateZ() const; 175 176 177 /** 178 * Predicate returning @c true if this CSGTranslation's "translateX" 179 * attribute is set. 180 * 181 * @return @c true if this CSGTranslation's "translateX" attribute has been 182 * set, otherwise @c false is returned. 183 */ 184 bool isSetTranslateX() const; 185 186 187 /** 188 * Predicate returning @c true if this CSGTranslation's "translateY" 189 * attribute is set. 190 * 191 * @return @c true if this CSGTranslation's "translateY" attribute has been 192 * set, otherwise @c false is returned. 193 */ 194 bool isSetTranslateY() const; 195 196 197 /** 198 * Predicate returning @c true if this CSGTranslation's "translateZ" 199 * attribute is set. 200 * 201 * @return @c true if this CSGTranslation's "translateZ" attribute has been 202 * set, otherwise @c false is returned. 203 */ 204 bool isSetTranslateZ() const; 205 206 207 /** 208 * Sets the value of the "translateX" attribute of this CSGTranslation. 209 * 210 * @param translateX double value of the "translateX" attribute to be set. 211 * 212 * @copydetails doc_returns_success_code 213 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 214 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, 215 * OperationReturnValues_t} 216 */ 217 int setTranslateX(double translateX); 218 219 220 /** 221 * Sets the value of the "translateY" attribute of this CSGTranslation. 222 * 223 * @param translateY double value of the "translateY" attribute to be set. 224 * 225 * @copydetails doc_returns_success_code 226 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 227 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, 228 * OperationReturnValues_t} 229 */ 230 int setTranslateY(double translateY); 231 232 233 /** 234 * Sets the value of the "translateZ" attribute of this CSGTranslation. 235 * 236 * @param translateZ double value of the "translateZ" attribute to be set. 237 * 238 * @copydetails doc_returns_success_code 239 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 240 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, 241 * OperationReturnValues_t} 242 */ 243 int setTranslateZ(double translateZ); 244 245 246 /** 247 * Unsets the value of the "translateX" attribute of this CSGTranslation. 248 * 249 * @copydetails doc_returns_success_code 250 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 251 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 252 */ 253 int unsetTranslateX(); 254 255 256 /** 257 * Unsets the value of the "translateY" attribute of this CSGTranslation. 258 * 259 * @copydetails doc_returns_success_code 260 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 261 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 262 */ 263 int unsetTranslateY(); 264 265 266 /** 267 * Unsets the value of the "translateZ" attribute of this CSGTranslation. 268 * 269 * @copydetails doc_returns_success_code 270 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 271 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 272 */ 273 int unsetTranslateZ(); 274 275 276 /** 277 * Returns the XML element name of this CSGTranslation object. 278 * 279 * For CSGTranslation, the XML element name is always @c "csgTranslation". 280 * 281 * @return the name of this element, i.e. @c "csgTranslation". 282 */ 283 virtual const std::string& getElementName() const; 284 285 286 /** 287 * Returns the libSBML type code for this CSGTranslation object. 288 * 289 * @copydetails doc_what_are_typecodes 290 * 291 * @return the SBML type code for this object: 292 * @sbmlconstant{SBML_SPATIAL_CSGTRANSLATION, SBMLSpatialTypeCode_t}. 293 * 294 * @copydetails doc_warning_typecodes_not_unique 295 * 296 * @see getElementName() 297 * @see getPackageName() 298 */ 299 virtual int getTypeCode() const; 300 301 302 /** 303 * Predicate returning @c true if all the required attributes for this 304 * CSGTranslation object have been set. 305 * 306 * @return @c true to indicate that all the required attributes of this 307 * CSGTranslation have been set, otherwise @c false is returned. 308 * 309 * 310 * @note The required attributes for the CSGTranslation object are: 311 * @li "translateX" 312 */ 313 virtual bool hasRequiredAttributes() const; 314 315 316 317 /** @cond doxygenLibsbmlInternal */ 318 319 /** 320 * Write any contained elements 321 */ 322 virtual void writeElements(XMLOutputStream& stream) const; 323 324 /** @endcond */ 325 326 327 328 /** @cond doxygenLibsbmlInternal */ 329 330 /** 331 * Accepts the given SBMLVisitor 332 */ 333 virtual bool accept(SBMLVisitor& v) const; 334 335 /** @endcond */ 336 337 338 339 /** @cond doxygenLibsbmlInternal */ 340 341 /** 342 * Sets the parent SBMLDocument 343 */ 344 virtual void setSBMLDocument(SBMLDocument* d); 345 346 /** @endcond */ 347 348 349 350 /** @cond doxygenLibsbmlInternal */ 351 352 /** 353 * Enables/disables the given package with this element 354 */ 355 virtual void enablePackageInternal(const std::string& pkgURI, 356 const std::string& pkgPrefix, 357 bool flag); 358 359 /** @endcond */ 360 361 362 363 364 #ifndef SWIG 365 366 367 368 /** @cond doxygenLibsbmlInternal */ 369 370 /** 371 * Gets the value of the "attributeName" attribute of this CSGTranslation. 372 * 373 * @param attributeName, the name of the attribute to retrieve. 374 * 375 * @param value, the address of the value to record. 376 * 377 * @copydetails doc_returns_success_code 378 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 379 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 380 */ 381 virtual int getAttribute(const std::string& attributeName, bool& value) 382 const; 383 384 /** @endcond */ 385 386 387 388 /** @cond doxygenLibsbmlInternal */ 389 390 /** 391 * Gets the value of the "attributeName" attribute of this CSGTranslation. 392 * 393 * @param attributeName, the name of the attribute to retrieve. 394 * 395 * @param value, the address of the value to record. 396 * 397 * @copydetails doc_returns_success_code 398 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 399 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 400 */ 401 virtual int getAttribute(const std::string& attributeName, int& value) const; 402 403 /** @endcond */ 404 405 406 407 /** @cond doxygenLibsbmlInternal */ 408 409 /** 410 * Gets the value of the "attributeName" attribute of this CSGTranslation. 411 * 412 * @param attributeName, the name of the attribute to retrieve. 413 * 414 * @param value, the address of the value to record. 415 * 416 * @copydetails doc_returns_success_code 417 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 418 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 419 */ 420 virtual int getAttribute(const std::string& attributeName, 421 double& value) const; 422 423 /** @endcond */ 424 425 426 427 /** @cond doxygenLibsbmlInternal */ 428 429 /** 430 * Gets the value of the "attributeName" attribute of this CSGTranslation. 431 * 432 * @param attributeName, the name of the attribute to retrieve. 433 * 434 * @param value, the address of the value to record. 435 * 436 * @copydetails doc_returns_success_code 437 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 438 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 439 */ 440 virtual int getAttribute(const std::string& attributeName, 441 unsigned int& value) const; 442 443 /** @endcond */ 444 445 446 447 /** @cond doxygenLibsbmlInternal */ 448 449 /** 450 * Gets the value of the "attributeName" attribute of this CSGTranslation. 451 * 452 * @param attributeName, the name of the attribute to retrieve. 453 * 454 * @param value, the address of the value to record. 455 * 456 * @copydetails doc_returns_success_code 457 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 458 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 459 */ 460 virtual int getAttribute(const std::string& attributeName, 461 std::string& value) const; 462 463 /** @endcond */ 464 465 466 467 /** @cond doxygenLibsbmlInternal */ 468 469 /** 470 * Predicate returning @c true if this CSGTranslation's attribute 471 * "attributeName" is set. 472 * 473 * @param attributeName, the name of the attribute to query. 474 * 475 * @return @c true if this CSGTranslation's attribute "attributeName" has 476 * been set, otherwise @c false is returned. 477 */ 478 virtual bool isSetAttribute(const std::string& attributeName) const; 479 480 /** @endcond */ 481 482 483 484 /** @cond doxygenLibsbmlInternal */ 485 486 /** 487 * Sets the value of the "attributeName" attribute of this CSGTranslation. 488 * 489 * @param attributeName, the name of the attribute to set. 490 * 491 * @param value, the value of the attribute to set. 492 * 493 * @copydetails doc_returns_success_code 494 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 495 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 496 */ 497 virtual int setAttribute(const std::string& attributeName, bool value); 498 499 /** @endcond */ 500 501 502 503 /** @cond doxygenLibsbmlInternal */ 504 505 /** 506 * Sets the value of the "attributeName" attribute of this CSGTranslation. 507 * 508 * @param attributeName, the name of the attribute to set. 509 * 510 * @param value, the value of the attribute to set. 511 * 512 * @copydetails doc_returns_success_code 513 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 514 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 515 */ 516 virtual int setAttribute(const std::string& attributeName, int value); 517 518 /** @endcond */ 519 520 521 522 /** @cond doxygenLibsbmlInternal */ 523 524 /** 525 * Sets the value of the "attributeName" attribute of this CSGTranslation. 526 * 527 * @param attributeName, the name of the attribute to set. 528 * 529 * @param value, the value of the attribute to set. 530 * 531 * @copydetails doc_returns_success_code 532 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 533 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 534 */ 535 virtual int setAttribute(const std::string& attributeName, double value); 536 537 /** @endcond */ 538 539 540 541 /** @cond doxygenLibsbmlInternal */ 542 543 /** 544 * Sets the value of the "attributeName" attribute of this CSGTranslation. 545 * 546 * @param attributeName, the name of the attribute to set. 547 * 548 * @param value, the value of the attribute to set. 549 * 550 * @copydetails doc_returns_success_code 551 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 552 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 553 */ 554 virtual int setAttribute(const std::string& attributeName, 555 unsigned int value); 556 557 /** @endcond */ 558 559 560 561 /** @cond doxygenLibsbmlInternal */ 562 563 /** 564 * Sets the value of the "attributeName" attribute of this CSGTranslation. 565 * 566 * @param attributeName, the name of the attribute to set. 567 * 568 * @param value, the value of the attribute to set. 569 * 570 * @copydetails doc_returns_success_code 571 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 572 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 573 */ 574 virtual int setAttribute(const std::string& attributeName, 575 const std::string& value); 576 577 /** @endcond */ 578 579 580 581 /** @cond doxygenLibsbmlInternal */ 582 583 /** 584 * Unsets the value of the "attributeName" attribute of this CSGTranslation. 585 * 586 * @param attributeName, the name of the attribute to query. 587 * 588 * @copydetails doc_returns_success_code 589 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 590 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 591 */ 592 virtual int unsetAttribute(const std::string& attributeName); 593 594 /** @endcond */ 595 596 597 598 599 #endif /* !SWIG */ 600 601 602 protected: 603 604 605 /** @cond doxygenLibsbmlInternal */ 606 607 /** 608 * Creates a new object from the next XMLToken on the XMLInputStream 609 */ 610 virtual SBase* createObject(XMLInputStream& stream); 611 612 /** @endcond */ 613 614 615 616 /** @cond doxygenLibsbmlInternal */ 617 618 /** 619 * Adds the expected attributes for this element 620 */ 621 virtual void addExpectedAttributes(ExpectedAttributes& attributes); 622 623 /** @endcond */ 624 625 626 627 /** @cond doxygenLibsbmlInternal */ 628 629 /** 630 * Reads the expected attributes into the member data variables 631 */ 632 virtual void readAttributes(const XMLAttributes& attributes, 633 const ExpectedAttributes& expectedAttributes); 634 635 /** @endcond */ 636 637 638 639 /** @cond doxygenLibsbmlInternal */ 640 641 /** 642 * Writes the attributes to the stream 643 */ 644 virtual void writeAttributes(XMLOutputStream& stream) const; 645 646 /** @endcond */ 647 648 649 }; 650 651 652 653 LIBSBML_CPP_NAMESPACE_END 654 655 656 657 658 #endif /* __cplusplus */ 659 660 661 662 663 #ifndef SWIG 664 665 666 667 668 LIBSBML_CPP_NAMESPACE_BEGIN 669 670 671 672 673 BEGIN_C_DECLS 674 675 676 /** 677 * Creates a new CSGTranslation_t using the given SBML Level, Version and 678 * “spatial” package version. 679 * 680 * @param level an unsigned int, the SBML Level to assign to this 681 * CSGTranslation_t. 682 * 683 * @param version an unsigned int, the SBML Version to assign to this 684 * CSGTranslation_t. 685 * 686 * @param pkgVersion an unsigned int, the SBML Spatial Version to assign to 687 * this CSGTranslation_t. 688 * 689 * @copydetails doc_note_setting_lv_pkg 690 * 691 * @copydetails doc_returned_owned_pointer 692 * 693 * @memberof CSGTranslation_t 694 */ 695 LIBSBML_EXTERN 696 CSGTranslation_t * 697 CSGTranslation_create(unsigned int level, 698 unsigned int version, 699 unsigned int pkgVersion); 700 701 702 /** 703 * Creates and returns a deep copy of this CSGTranslation_t object. 704 * 705 * @param csgt the CSGTranslation_t structure. 706 * 707 * @return a (deep) copy of this CSGTranslation_t object. 708 * 709 * @copydetails doc_returned_owned_pointer 710 * 711 * @memberof CSGTranslation_t 712 */ 713 LIBSBML_EXTERN 714 CSGTranslation_t* 715 CSGTranslation_clone(const CSGTranslation_t* csgt); 716 717 718 /** 719 * Frees this CSGTranslation_t object. 720 * 721 * @param csgt the CSGTranslation_t structure. 722 * 723 * @memberof CSGTranslation_t 724 */ 725 LIBSBML_EXTERN 726 void 727 CSGTranslation_free(CSGTranslation_t* csgt); 728 729 730 /** 731 * Returns the value of the "translateX" attribute of this CSGTranslation_t. 732 * 733 * @param csgt the CSGTranslation_t structure whose translateX is sought. 734 * 735 * @return the value of the "translateX" attribute of this CSGTranslation_t as 736 * a double. 737 * 738 * @memberof CSGTranslation_t 739 */ 740 LIBSBML_EXTERN 741 double 742 CSGTranslation_getTranslateX(const CSGTranslation_t * csgt); 743 744 745 /** 746 * Returns the value of the "translateY" attribute of this CSGTranslation_t. 747 * 748 * @param csgt the CSGTranslation_t structure whose translateY is sought. 749 * 750 * @return the value of the "translateY" attribute of this CSGTranslation_t as 751 * a double. 752 * 753 * @memberof CSGTranslation_t 754 */ 755 LIBSBML_EXTERN 756 double 757 CSGTranslation_getTranslateY(const CSGTranslation_t * csgt); 758 759 760 /** 761 * Returns the value of the "translateZ" attribute of this CSGTranslation_t. 762 * 763 * @param csgt the CSGTranslation_t structure whose translateZ is sought. 764 * 765 * @return the value of the "translateZ" attribute of this CSGTranslation_t as 766 * a double. 767 * 768 * @memberof CSGTranslation_t 769 */ 770 LIBSBML_EXTERN 771 double 772 CSGTranslation_getTranslateZ(const CSGTranslation_t * csgt); 773 774 775 /** 776 * Predicate returning @c 1 (true) if this CSGTranslation_t's "translateX" 777 * attribute is set. 778 * 779 * @param csgt the CSGTranslation_t structure. 780 * 781 * @return @c 1 (true) if this CSGTranslation_t's "translateX" attribute has 782 * been set, otherwise @c 0 (false) is returned. 783 * 784 * @memberof CSGTranslation_t 785 */ 786 LIBSBML_EXTERN 787 int 788 CSGTranslation_isSetTranslateX(const CSGTranslation_t * csgt); 789 790 791 /** 792 * Predicate returning @c 1 (true) if this CSGTranslation_t's "translateY" 793 * attribute is set. 794 * 795 * @param csgt the CSGTranslation_t structure. 796 * 797 * @return @c 1 (true) if this CSGTranslation_t's "translateY" attribute has 798 * been set, otherwise @c 0 (false) is returned. 799 * 800 * @memberof CSGTranslation_t 801 */ 802 LIBSBML_EXTERN 803 int 804 CSGTranslation_isSetTranslateY(const CSGTranslation_t * csgt); 805 806 807 /** 808 * Predicate returning @c 1 (true) if this CSGTranslation_t's "translateZ" 809 * attribute is set. 810 * 811 * @param csgt the CSGTranslation_t structure. 812 * 813 * @return @c 1 (true) if this CSGTranslation_t's "translateZ" attribute has 814 * been set, otherwise @c 0 (false) is returned. 815 * 816 * @memberof CSGTranslation_t 817 */ 818 LIBSBML_EXTERN 819 int 820 CSGTranslation_isSetTranslateZ(const CSGTranslation_t * csgt); 821 822 823 /** 824 * Sets the value of the "translateX" attribute of this CSGTranslation_t. 825 * 826 * @param csgt the CSGTranslation_t structure. 827 * 828 * @param translateX double value of the "translateX" attribute to be set. 829 * 830 * @copydetails doc_returns_success_code 831 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 832 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t} 833 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 834 * 835 * @memberof CSGTranslation_t 836 */ 837 LIBSBML_EXTERN 838 int 839 CSGTranslation_setTranslateX(CSGTranslation_t * csgt, double translateX); 840 841 842 /** 843 * Sets the value of the "translateY" attribute of this CSGTranslation_t. 844 * 845 * @param csgt the CSGTranslation_t structure. 846 * 847 * @param translateY double value of the "translateY" attribute to be set. 848 * 849 * @copydetails doc_returns_success_code 850 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 851 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t} 852 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 853 * 854 * @memberof CSGTranslation_t 855 */ 856 LIBSBML_EXTERN 857 int 858 CSGTranslation_setTranslateY(CSGTranslation_t * csgt, double translateY); 859 860 861 /** 862 * Sets the value of the "translateZ" attribute of this CSGTranslation_t. 863 * 864 * @param csgt the CSGTranslation_t structure. 865 * 866 * @param translateZ double value of the "translateZ" attribute to be set. 867 * 868 * @copydetails doc_returns_success_code 869 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 870 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t} 871 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 872 * 873 * @memberof CSGTranslation_t 874 */ 875 LIBSBML_EXTERN 876 int 877 CSGTranslation_setTranslateZ(CSGTranslation_t * csgt, double translateZ); 878 879 880 /** 881 * Unsets the value of the "translateX" attribute of this CSGTranslation_t. 882 * 883 * @param csgt the CSGTranslation_t structure. 884 * 885 * @copydetails doc_returns_success_code 886 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 887 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 888 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 889 * 890 * @memberof CSGTranslation_t 891 */ 892 LIBSBML_EXTERN 893 int 894 CSGTranslation_unsetTranslateX(CSGTranslation_t * csgt); 895 896 897 /** 898 * Unsets the value of the "translateY" attribute of this CSGTranslation_t. 899 * 900 * @param csgt the CSGTranslation_t structure. 901 * 902 * @copydetails doc_returns_success_code 903 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 904 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 905 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 906 * 907 * @memberof CSGTranslation_t 908 */ 909 LIBSBML_EXTERN 910 int 911 CSGTranslation_unsetTranslateY(CSGTranslation_t * csgt); 912 913 914 /** 915 * Unsets the value of the "translateZ" attribute of this CSGTranslation_t. 916 * 917 * @param csgt the CSGTranslation_t structure. 918 * 919 * @copydetails doc_returns_success_code 920 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t} 921 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t} 922 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t} 923 * 924 * @memberof CSGTranslation_t 925 */ 926 LIBSBML_EXTERN 927 int 928 CSGTranslation_unsetTranslateZ(CSGTranslation_t * csgt); 929 930 931 /** 932 * Predicate returning @c 1 (true) if all the required attributes for this 933 * CSGTranslation_t object have been set. 934 * 935 * @param csgt the CSGTranslation_t structure. 936 * 937 * @return @c 1 (true) to indicate that all the required attributes of this 938 * CSGTranslation_t have been set, otherwise @c 0 (false) is returned. 939 * 940 * 941 * @note The required attributes for the CSGTranslation_t object are: 942 * @li "translateX" 943 * 944 * @memberof CSGTranslation_t 945 */ 946 LIBSBML_EXTERN 947 int 948 CSGTranslation_hasRequiredAttributes(const CSGTranslation_t * csgt); 949 950 951 952 953 END_C_DECLS 954 955 956 957 958 LIBSBML_CPP_NAMESPACE_END 959 960 961 962 963 #endif /* !SWIG */ 964 965 966 967 968 #endif /* !CSGTranslation_H__ */ 969 970 971