libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
convertSBML.c

Example demonstrating how to convert SBML documents between SBML Levels.

Example demonstrating how to convert SBML documents between SBML Levels.

/**
* @file convertSBML.c
* @brief Converts SBML documents between levels
* @author Ben Bornstein
* @author Michael Hucka
*
* <!--------------------------------------------------------------------------
* 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 <stdio.h>
#include <sbml/SBMLTypes.h>
int
main (int argc, char *argv[])
{
unsigned int latestLevel = SBMLDocument_getDefaultLevel();
unsigned int latestVersion = SBMLDocument_getDefaultVersion();
unsigned int errors;
if (argc != 3)
{
printf("Usage: convertSBML input-filename output-filename\n");
printf("This program will attempt to convert a model either to\n");
printf("SBML Level %d Version %d (if the model is not already) or, if",
latestLevel, latestVersion);
printf("the model is already expressed in Level %d Version %d, this\n",
latestLevel, latestVersion);
printf("program will attempt to convert the model to Level 1 Version 2.\n");
return 1;
}
d = readSBML(argv[1]);
if (errors > 0)
{
printf("Encountered the following SBML error(s):\n");
printf("Conversion skipped. Please correct the problems above first.\n");
return errors;
}
else
{
unsigned int olevel = SBMLDocument_getLevel(d);
unsigned int oversion = SBMLDocument_getVersion(d);
int success;
if (olevel < latestLevel || oversion < latestVersion)
{
printf("Attempting to convert model to SBML Level %d Version %d.\n",
latestLevel, latestVersion);
success = SBMLDocument_setLevelAndVersion(d, latestLevel, latestVersion);
}
else
{
printf("Attempting to convert model to SBML Level 1 Version 2.\n");
success = SBMLDocument_setLevelAndVersion(d, 1, 2);
}
if (!success)
{
printf("Unable to perform conversion due to the following:\n");
printf("Conversion skipped. Either libSBML does not (yet) have\n");
printf("ability to convert this model, or (automatic) conversion\n");
printf("is not possible in this case.\n");
return errors;
}
if (errors > 0)
{
printf("Information may have been lost in conversion; but a valid model ");
printf("was produced by the conversion.\nThe following information ");
printf("was provided:\n");
writeSBML(d, argv[2]);
}
else
{
printf("Conversion completed.\n");
writeSBML(d, argv[2]);
}
}
return 0;
}
unsigned int SBMLDocument_getLevel(const SBMLDocument_t *d)
_tReturns_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t.
Definition SBMLDocument.cpp:2266
void SBMLDocument_printErrors(SBMLDocument_t *d, FILE *stream)
_tPrints_t _tto_t _tthe_t _tgiven_t _toutput_t _tstream_t _tall_t _tthe_t _terrors_t _tor_t _twarning...
Definition SBMLDocument.cpp:2525
int SBMLDocument_setLevelAndVersion(SBMLDocument_t *d, unsigned int level, unsigned int version)
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t,...
Definition SBMLDocument.cpp:2316
unsigned int SBMLDocument_getNumErrors(const SBMLDocument_t *d)
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tpar...
Definition SBMLDocument.cpp:2510
unsigned int SBMLDocument_getDefaultLevel()
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tlevel_t (_tat_t _tthe_t _ttime_t...
Definition SBMLDocument.cpp:2541
void SBMLDocument_free(SBMLDocument_t *d)
_tFrees_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t.
Definition SBMLDocument.cpp:2248
unsigned int SBMLDocument_getDefaultVersion()
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tversion_t (_tat_t _tthe_t _ttime...
Definition SBMLDocument.cpp:2548
unsigned int SBMLDocument_getVersion(const SBMLDocument_t *d)
_tReturns_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBML...
Definition SBMLDocument.cpp:2274
SBMLDocument_t * readSBML(const char *filename)
@_tcopydoc_t _tdoc_readsbmlfromfile_t
Definition SBMLReader.cpp:446
Include all SBML types in a single header file.
int writeSBML(const SBMLDocument_t *d, const char *filename)
_tWrites_t _tthe_t _tgiven_t _tSBML_t _tdocument_t @_tp_t _td_t _tto_t _tthe_t _tfile_t _tnamed_t _tb...
Definition SBMLWriter.cpp:440