/usr/include/sbml/annotation/ModelCreator.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 | /**
* @file ModelCreator.h
* @brief ModelCreator I/O
* @author Sarah Keating
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2017 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*
* @class ModelCreator
* @sbmlbrief{core} MIRIAM-compliant data about a model's creator.
*
* @htmlinclude not-sbml-warning.html
*
* The SBML specification beginning with Level 2 Version 2
* defines a standard approach to recording model history and model creator
* information in a form that complies with MIRIAM ("Minimum Information
* Requested in the Annotation of biochemical Models", <i>Nature
* Biotechnology</i>, vol. 23, no. 12, Dec. 2005). For the model creator,
* this form involves the use of parts of the <a target="_blank"
* href="http://en.wikipedia.org/wiki/VCard">vCard</a> representation.
* LibSBML provides the ModelCreator class as a convenience high-level
* interface for working with model creator data. Objects of class
* ModelCreator can be used to store and carry around creator data within a
* program, and the various methods in this object class let callers
* manipulate the different parts of the model creator representation.
*
* @section parts The different parts of a model creator definition
*
* The ModelCreator class mirrors the structure of the MIRIAM model creator
* annotations in SBML. The following template illustrates these different
* fields when they are written in XML form:
*
<pre class="fragment">
<vCard:N rdf:parseType="Resource">
<vCard:Family><span style="background-color: #bbb">family name</span></vCard:Family>
<vCard:Given><span style="background-color: #bbb">given name</span></vCard:Given>
</vCard:N>
...
<vCard:EMAIL><span style="background-color: #bbb">email address</span></vCard:EMAIL>
...
<vCard:ORG rdf:parseType="Resource">
<vCard:Orgname><span style="background-color: #bbb">organization</span></vCard:Orgname>
</vCard:ORG>
</pre>
*
* Each of the separate data values
* <span class="code" style="background-color: #bbb">family name</span>,
* <span class="code" style="background-color: #bbb">given name</span>,
* <span class="code" style="background-color: #bbb">email address</span>, and
* <span class="code" style="background-color: #bbb">organization</span> can
* be set and retrieved via corresponding methods in the ModelCreator
* class. These methods are documented in more detail below.
*
* <!-- leave this next break as-is to work around some doxygen bug -->
*/
#ifndef ModelCreator_h
#define ModelCreator_h
#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/common/operationReturnValues.h>
#include <sbml/util/List.h>
#include <sbml/xml/XMLNode.h>
#ifdef __cplusplus
#include <string>
LIBSBML_CPP_NAMESPACE_BEGIN
class LIBSBML_EXTERN ModelCreator
{
public:
/**
* Creates a new ModelCreator object.
*/
ModelCreator ();
/**
* Creates a new ModelCreator from an XMLNode.
*
* @param creator the XMLNode from which to create the ModelCreator.
*/
ModelCreator(const XMLNode creator);
/**
* Destroys the ModelCreator.
*/
~ModelCreator();
/**
* Copy constructor; creates a copy of the ModelCreator.
*
* @param orig the object to copy.
*/
ModelCreator(const ModelCreator& orig);
/**
* Assignment operator.
*
* @param rhs the object whose values are used as the basis of the
* assignment.
*/
ModelCreator& operator=(const ModelCreator& rhs);
/**
* Creates and returns a deep copy of this ModelCreator object.
*
* @return the (deep) copy of this ModelCreator object.
*/
ModelCreator* clone () const;
/**
* Returns the "family name" stored in this ModelCreator object.
*
* @return the "family name" portion of the ModelCreator object.
*/
const std::string& getFamilyName() const { return mFamilyName; }
/**
* Returns the "given name" stored in this ModelCreator object.
*
* @return the "given name" portion of the ModelCreator object.
*/
const std::string& getGivenName() const { return mGivenName; }
/**
* Returns the "email" stored in this ModelCreator object.
*
* @return email from the ModelCreator.
*/
const std::string& getEmail() const { return mEmail; }
/**
* Returns the "organization" stored in this ModelCreator object.
*
* @return organization from the ModelCreator.
*/
const std::string& getOrganization() const{ return mOrganization; }
/**
* (Alternate spelling) Returns the "organization" stored in this
* ModelCreator object.
*
* @note This function is an alias of getOrganization().
*
* @return organization from the ModelCreator.
*
* @see getOrganization()
*/
const std::string& getOrganisation() const{ return mOrganization; }
/**
* Returns the "fn" stored in this ModelCreator object when using vCard4.
*
* @return the "fn" portion of the ModelCreator object.
*/
const std::string& getName() const { return mFamilyName; }
/**
* Predicate returning @c true or @c false depending on whether this
* ModelCreator's "family name" part is set.
*
* @return @c true if the familyName of this ModelCreator is set, @c false otherwise.
*/
bool isSetFamilyName();
/**
* Predicate returning @c true or @c false depending on whether this
* ModelCreator's "given name" part is set.
*
* @return @c true if the givenName of this ModelCreator is set, @c false otherwise.
*/
bool isSetGivenName();
/**
* Predicate returning @c true or @c false depending on whether this
* ModelCreator's "email" part is set.
*
* @return @c true if the email of this ModelCreator is set, @c false otherwise.
*/
bool isSetEmail();
/**
* Predicate returning @c true or @c false depending on whether this
* ModelCreator's "organization" part is set.
*
* @return @c true if the organization of this ModelCreator is set, @c false otherwise.
*/
bool isSetOrganization();
/**
* (Alternate spelling) Predicate returning @c true or @c false depending
* on whether this ModelCreator's "organization" part is set.
*
* @note This function is an alias of isSetOrganization().
*
* @return @c true if the organization of this ModelCreator is set, @c false otherwise.
*
* @see isSetOrganization()
*/
bool isSetOrganisation();
/**
* Predicate returning @c true or @c false depending on whether this
* ModelCreator's "fn" part is set (when using vCard4).
*
* @return @c true if the fn of this ModelCreator is set, @c false otherwise.
*/
bool isSetName();
/**
* Sets the "family name" portion of this ModelCreator object.
*
* @param familyName a string representing the familyName of the ModelCreator.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
int setFamilyName(const std::string& familyName);
/**
* Sets the "given name" portion of this ModelCreator object.
*
* @param givenName a string representing the givenName of the ModelCreator.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
int setGivenName(const std::string& givenName);
/**
* Sets the "email" portion of this ModelCreator object.
*
* @param email a string representing the email of the ModelCreator.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
int setEmail(const std::string& email);
/**
* Sets the "organization" portion of this ModelCreator object.
*
* @param organization a string representing the organization of the
* ModelCreator.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
int setOrganization(const std::string& organization);
/**
* (Alternate spelling) Sets the "organization" portion of this
* ModelCreator object.
*
* @param organization a string representing the organization of the
* ModelCreator.
*
* @note This function is an alias of setOrganization(const std::string& organization).
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*
* @see setOrganization(std::string organization)
*/
int setOrganisation(const std::string& organization);
/**
* Sets the "fn" portion of this ModelCreator object (when using vCard4).
*
* @param name a string representing the fn of the ModelCreator.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
*/
int setName(const std::string& name);
/**
* Unsets the "family name" portion of this ModelCreator object.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetFamilyName();
/**
* Unsets the "given name" portion of this ModelCreator object.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetGivenName();
/**
* Unsets the "email" portion of this ModelCreator object.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetEmail();
/**
* Unsets the "organization" portion of this ModelCreator object.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetOrganization();
/**
* (Alternate spelling) Unsets the "organization" portion of this ModelCreator object.
*
* @note This function is an alias of unsetOrganization().
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*
* @see unsetOrganization()
*/
int unsetOrganisation();
/**
* Unsets the "fn" portion of this ModelCreator object (when using vCard4).
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
*/
int unsetName();
/** @cond doxygenLibsbmlInternal */
XMLNode * getAdditionalRDF();
/** @endcond */
/**
* Predicate returning @c true if all the required elements for this
* ModelCreator object have been set.
*
* The only required elements for a ModelCreator object are the "family
* name" and "given name".
*
* @return a boolean value indicating whether all the required
* elements for this object have been defined.
*/
bool hasRequiredAttributes();
/** @cond doxygenLibsbmlInternal */
bool hasBeenModified();
void resetModifiedFlags();
bool usingFNVcard4() { return mUsingFNVcard4; };
bool usingSingleName();
void setUseSingleName(bool flag);
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
std::string mFamilyName;
std::string mGivenName;
std::string mEmail;
std::string mOrganization;
XMLNode * mAdditionalRDF;
bool mHasBeenModified;
bool mUsingFNVcard4;
bool mUseSingleName;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Creates a new ModelCreator_t structure and returns a pointer to it.
*
* @return pointer to newly created ModelCreator_t structure.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
ModelCreator_t *
ModelCreator_create();
/**
* Creates a new ModelCreator_t structure from an XMLNode_t structure
* and returns a pointer to it.
*
* @return pointer to newly created ModelCreator_t structure.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
ModelCreator_t *
ModelCreator_createFromNode(const XMLNode_t * node);
/**
* Destroys this ModelCreator_t.
*
* @param mc ModelCreator_t structure to be freed.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
void
ModelCreator_free(ModelCreator_t* mc);
/**
* Creates a deep copy of the given ModelCreator_t structure
*
* @param mc the ModelCreator_t structure to be copied.
*
* @return a (deep) copy of the given ModelCreator_t structure.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
ModelCreator_t *
ModelCreator_clone (const ModelCreator_t* mc);
/**
* Returns the familyName from the ModelCreator_t.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return familyName from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getFamilyName(ModelCreator_t *mc);
/**
* Returns the givenName from the ModelCreator_t.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return givenName from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getGivenName(ModelCreator_t *mc);
/**
* Returns the email from the ModelCreator_t.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return email from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getEmail(ModelCreator_t *mc);
/**
* Returns the organization from the ModelCreator_t.
*
* @note This function is an alias of ModelCreator_getOrganization().
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return organization from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getOrganisation(ModelCreator_t *mc);
/**
* Returns the organization from the ModelCreator_t.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return organization from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getOrganization(ModelCreator_t *mc);
/**
* Returns the fn from the ModelCreator_t (when using vCard4).
*
* @param mc the ModelCreator_t structure to be queried
*
* @return fn from the ModelCreator_t.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
const char *
ModelCreator_getName(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's familyName is set.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return @c 1 (true) if the familyName of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetFamilyName(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's givenName is set.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return @c 1 (true) if the givenName of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetGivenName(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's email is set.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return @c 1 (true) if the email of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetEmail(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's organization is set.
*
* @note This function is an alias of ModelCreator_isSetOrganization().
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return @c 1 (true) if the organization of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetOrganisation(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's organization is set.
*
* @param mc the ModelCreator_t structure to be queried.
*
* @return @c 1 (true) if the organization of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetOrganization(ModelCreator_t *mc);
/**
* Predicate indicating whether this
* ModelCreator_t's fn is set (when using vCard4).
*
* @param mc the ModelCreator_t structure to be queried
*
* @return @c 1 (true) if the fn of this
* ModelCreator_t structure is set, @c 0 (false) otherwise.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_isSetName(ModelCreator_t *mc);
/**
* Sets the family name
*
* @param mc the ModelCreator_t structure.
* @param name a string representing the familyName of the ModelCreator_t.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setFamilyName(ModelCreator_t *mc, const char * name);
/**
* Sets the given name
*
* @param mc the ModelCreator_t structure.
* @param name a string representing the givenName of the ModelCreator_t.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setGivenName(ModelCreator_t *mc, const char * name);
/**
* Sets the email
*
* @param mc the ModelCreator_t structure.
* @param email a string representing the email of the ModelCreator_t.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setEmail(ModelCreator_t *mc, const char * email);
/**
* Sets the organization
*
* @param mc the ModelCreator_t structure.
* @param org a string representing the organisation of the ModelCreator_t.
*
* @note This function is an alias of ModelCreator_setOrganization().
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setOrganisation(ModelCreator_t *mc, const char* org);
/**
* Sets the organization
*
* @param mc the ModelCreator_t structure.
* @param org a string representing the organisation of the ModelCreator_t.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setOrganization(ModelCreator_t *mc, const char* org);
/**
* Sets the name
*
* @param mc the ModelCreator_t structure
* @param name a string representing the familyName of the ModelCreator_t.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_setName(ModelCreator_t *mc, const char * name);
/**
* Unsets the familyName of this ModelCreator_t.
*
* @param mc the ModelCreator_t structure.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetFamilyName(ModelCreator_t *mc);
/**
* Unsets the givenName of this ModelCreator_t.
*
* @param mc the ModelCreator_t structure.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetGivenName(ModelCreator_t *mc);
/**
* Unsets the email of this ModelCreator_t.
*
* @param mc the ModelCreator_t structure.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetEmail(ModelCreator_t *mc);
/**
* Unsets the organization of this ModelCreator_t.
*
* @param mc the ModelCreator_t structure.
*
* @note This function is an alias of ModelCreator_unsetOrganization().
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetOrganisation(ModelCreator_t *mc);
/**
* Unsets the organization of this ModelCreator_t.
*
* @param mc the ModelCreator_t structure.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetOrganization(ModelCreator_t *mc);
/**
* Unsets the fn of this ModelCreator_t (when using vCard4).
*
* @param mc the ModelCreator_t structure.
*
* @copydetails doc_returns_success_code
* @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
* @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_unsetName(ModelCreator_t *mc);
/**
* Checks if the model creator has all the required attributes.
*
* @param mc the ModelCreator_t structure.
*
* @return @c 1 (true) if this ModelCreator_t has all the required elements,
* otherwise @c 0 (false) will be returned, including if an invalid
* CVTerm_t was provided.
*
* @memberof ModelCreator_t
*/
LIBSBML_EXTERN
int
ModelCreator_hasRequiredAttributes(ModelCreator_t *mc);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /** ModelCreator_h **/
|