libSBML C++ API  5.20.4
inlineFunctionDefintions.cpp

Loads an SBML File and inlines all the function definitions found in the model.

/**
* @file inlineFunctionDefintions.cpp
* @brief Loads an SBML File and inlines all function definitions
* @author Michael Hucka
* @author Sarah Keating
* @author Frank T. Bergmann
*
* <!--------------------------------------------------------------------------
* 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
int
main (int argc, char *argv[])
{
if (argc != 3)
{
cout
<< endl
<< "Usage: inlineFunctionDefintions input-filename output-filename" << endl
<< endl
<< "This program will attempt to inline all function definitions" << endl
<< "contained in the source model, and write a new SBML file."
<< endl
<< endl;
return 1;
}
const char* inputFile = argv[1];
const char* outputFile = argv[2];
// read document
SBMLDocument* document = readSBML(inputFile);
unsigned int errors = document->getNumErrors(LIBSBML_SEV_ERROR);
// stop in case of errors
if (errors > 0)
{
cerr << "Encountered the following SBML errors:" << endl;
document->printErrors(cerr);
cerr << "Conversion skipped. Please correct the problems above first."
<< endl;
return errors;
}
// create conversion object that identifies the function definition converter
props.addOption("expandFunctionDefinitions", true,
"Expand all function definitions in the model");
// convert
int success = document->convert(props);
if (success != LIBSBML_OPERATION_SUCCESS)
{
cerr << "Unable to perform conversion due to the following:" << endl;
document->printErrors(cerr);
return errors;
}
else
{
cout << "Conversion completed." << endl;
writeSBML(document, outputFile);
}
delete document;
return 0;
}
Definition of ConversionProperties, the class encapsulating conversion configuration.
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.
@ LIBSBML_SEV_ERROR
Definition: XMLError.h:534
Definition: ConversionProperties.h:84
virtual void addOption(const ConversionOption &option)
Adds a copy of the given option to this properties object.
Definition: ConversionProperties.cpp:232
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
virtual int convert(const ConversionProperties &props)
Converts this document using the converter that best matches the given conversion properties.
@ LIBSBML_OPERATION_SUCCESS
Definition: operationReturnValues.h:61