libSBML C++ API  5.20.4
addModelHistory.cpp

Adds a model history to a model.

/**
* \file addModelHistory.cpp
* \brief adds Model History to a model
* \author Sarah Keating
*
* <!--------------------------------------------------------------------------
* This sample program is distributed under a different license than the rest
* of libSBML. This program uses the open-source MIT license, as follows:
*
* Copyright (c) 2013-2018 by the California Institute of Technology
* (California, USA), the European Bioinformatics Institute (EMBL-EBI, UK)
* and the University of Heidelberg (Germany), with support from the National
* Institutes of Health (USA) under grant R01GM070923. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Neither the name of the California Institute of Technology (Caltech), nor
* of the European Bioinformatics Institute (EMBL-EBI), nor of the University
* of Heidelberg, nor the names of any contributors, may be used to endorse
* or promote products derived from this software without specific prior
* written permission.
* ------------------------------------------------------------------------ -->
*/
#include <iostream>
#include <sbml/SBMLTypes.h>
using namespace std;
LIBSBML_CPP_NAMESPACE_USE
void printStatus(std::string message, int status)
{
std::string statusString;
switch(status)
{
statusString = "succeeded";
break;
statusString = "invalid object";
break;
statusString = "operation failed";
break;
default:
statusString = "unknown";
break;
}
cout << message << statusString << endl;
}
int
main (int argc, char *argv[])
{
unsigned int errors;
if (argc != 3)
{
cout << endl
<< " usage: addModelHistory <input-filename> <output-filename>" << endl
<< endl;
return 2;
}
d = readSBML(argv[1]);
errors = d->getNumErrors();
if (errors > 0)
{
cout << "Read Error(s):" << endl;
d->printErrors(cout);
cout << "Correct the above and re-run." << endl;
}
else
{
c->setFamilyName("Keating");
c->setGivenName("Sarah");
c->setEmail("sbml-team@caltech.edu");
c->setOrganization("University of Hertfordshire");
int status = h->addCreator(c);
printStatus("Status for addCreator: ", status);
Date * date = new Date("1999-11-13T06:54:32");
Date * date2 = new Date("2007-11-30T06:54:00-02:00");
status = h->setCreatedDate(date);
printStatus("Set created date: ", status);
status = h->setModifiedDate(date2);
printStatus("Set modified date: ", status);
status = d->getModel()->setModelHistory(h);
printStatus("Set model history: ", status);
delete h;
delete c;
delete date;
delete date2;
writeSBML(d, argv[2]);
}
delete d;
return errors;
}
ModelHistory I/O.
SBMLDocument_t * readSBML(const char *filename)
Reads an SBML document from the given file.
Include all SBML types in a single header file.
int writeSBML(const SBMLDocument_t *d, const char *filename)
Writes the given SBML document d to the file named by filename.
Class definition of XMLNode, a node in an XML document tree.
Definition: Date.h:203
Definition: ModelCreator.h:111
int setGivenName(const std::string &givenName)
Sets the "given name" portion of this ModelCreator object.
Definition: ModelCreator.cpp:308
int setOrganization(const std::string &organization)
Sets the "organization" portion of this ModelCreator object.
Definition: ModelCreator.cpp:334
int setFamilyName(const std::string &familyName)
Sets the "family name" portion of this ModelCreator object.
Definition: ModelCreator.cpp:293
int setEmail(const std::string &email)
Sets the "email" portion of this ModelCreator object.
Definition: ModelCreator.cpp:323
Definition: ModelHistory.h:138
int setModifiedDate(Date *date)
Sets the modification date of this ModelHistory object.
Definition: ModelHistory.cpp:246
int addCreator(ModelCreator *mc)
Adds a copy of a ModelCreator object to the list of "model creator" values stored in this ModelHistor...
Definition: ModelHistory.cpp:190
int setCreatedDate(Date *date)
Sets the creation date of this ModelHistory object.
Definition: ModelHistory.cpp:213
Definition: SBMLDocument.h:351
unsigned int getNumErrors() const
Returns the number of errors or warnings encountered during parsing, consistency checking,...
Definition: SBMLDocument.cpp:1169
void printErrors(std::ostream &stream=std::cerr) const
Prints all the errors or warnings encountered trying to parse, check, or translate this SBML document...
Definition: SBMLDocument.cpp:1192
const Model * getModel() const
Returns the Model object stored in this SBMLDocument.
Definition: SBMLDocument.cpp:350
int setModelHistory(ModelHistory *history)
Sets the ModelHistory of this object.
Definition: SBase.cpp:2295
@ LIBSBML_INVALID_OBJECT
Definition: operationReturnValues.h:96
@ LIBSBML_OPERATION_FAILED
Definition: operationReturnValues.h:83
@ LIBSBML_OPERATION_SUCCESS
Definition: operationReturnValues.h:61