libSBML C++ API  5.20.2
printSBML.cpp

Prints information about the top-level model in the given SBML file.

/**
* @file printModel.cpp
* @brief Prints some information about the top-level model
* @author Sarah Keating
* @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 <iostream>
#include <sbml/SBMLTypes.h>
using namespace std;
LIBSBML_CPP_NAMESPACE_USE
int
main (int argc, char* argv[])
{
if (argc != 2)
{
cout << endl << "Usage: printSBML filename" << endl << endl;
return 1;
}
const char* filename = argv[1];
SBMLDocument* document = readSBML(filename);
if (document->getNumErrors() > 0)
{
cerr << "Encountered the following SBML errors:" << endl;
document->printErrors(cerr);
return 1;
}
unsigned int level = document->getLevel ();
unsigned int version = document->getVersion();
cout << endl
<< "File: " << filename
<< " (Level " << level << ", version " << version << ")" << endl;
Model* model = document->getModel();
if (model == 0)
{
cout << "No model present." << endl;
return 1;
}
cout << " "
<< (level == 1 ? "name: " : " id: ")
<< (model->isSetId() ? model->getId() : std::string("(empty)")) << endl;
if (model->isSetSBOTerm())
cout << " model sboTerm: " << model->getSBOTerm() << endl;
cout << "functionDefinitions: " << model->getNumFunctionDefinitions() << endl;
cout << " unitDefinitions: " << model->getNumUnitDefinitions () << endl;
cout << " compartmentTypes: " << model->getNumCompartmentTypes () << endl;
cout << " specieTypes: " << model->getNumSpeciesTypes () << endl;
cout << " compartments: " << model->getNumCompartments () << endl;
cout << " species: " << model->getNumSpecies () << endl;
cout << " parameters: " << model->getNumParameters () << endl;
cout << " initialAssignments: " << model->getNumInitialAssignments () << endl;
cout << " rules: " << model->getNumRules () << endl;
cout << " constraints: " << model->getNumConstraints () << endl;
cout << " reactions: " << model->getNumReactions () << endl;
cout << " events: " << model->getNumEvents () << endl;
cout << endl;
delete document;
return 0;
}
SBMLDocument_t * readSBML(const char *filename)
Reads an SBML document from the given file.
Include all SBML types in a single header file.
Definition: Model.h:485
unsigned int getNumSpecies() const
Get the number of Species objects in this Model.
Definition: Model.cpp:3123
unsigned int getNumFunctionDefinitions() const
Get the number of FunctionDefinition objects in this Model.
Definition: Model.cpp:3073
unsigned int getNumParameters() const
Get the number of Parameter objects in this Model.
Definition: Model.cpp:3152
unsigned int getNumSpeciesTypes() const
Get the number of SpeciesType objects in this Model.
Definition: Model.cpp:3103
unsigned int getNumRules() const
Get the number of Rule objects in this Model.
Definition: Model.cpp:3172
unsigned int getNumInitialAssignments() const
Get the number of InitialAssignment objects in this Model.
Definition: Model.cpp:3162
unsigned int getNumCompartmentTypes() const
Get the number of CompartmentType objects in this Model.
Definition: Model.cpp:3093
unsigned int getNumUnitDefinitions() const
Get the number of UnitDefinition objects in this Model.
Definition: Model.cpp:3083
unsigned int getNumCompartments() const
Get the number of Compartment objects in this Model.
Definition: Model.cpp:3113
unsigned int getNumReactions() const
Get the number of Reaction objects in this Model.
Definition: Model.cpp:3192
virtual bool isSetId() const
Predicate returning true if this Model's "id" attribute is set.
Definition: Model.cpp:618
virtual const std::string & getId() const
Returns the value of the "id" attribute of this Model.
unsigned int getNumConstraints() const
Get the number of Constraint objects in this Model.
Definition: Model.cpp:3182
unsigned int getNumEvents() const
Get the number of Event objects in this Model.
Definition: Model.cpp:3202
Definition: SBMLDocument.h:349
unsigned int getNumErrors() const
Returns the number of errors or warnings encountered during parsing, consistency checking,...
Definition: SBMLDocument.cpp:1163
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:1186
const Model * getModel() const
Returns the Model object stored in this SBMLDocument.
Definition: SBMLDocument.cpp:350
bool isSetSBOTerm() const
Predicate returning true if this object's "sboTerm" attribute is set.
Definition: SBase.cpp:1166
int getSBOTerm() const
Returns the integer portion of the value of the "sboTerm" attribute of this object.
Definition: SBase.cpp:998
unsigned int getVersion() const
Returns the Version within the SBML Level of the SBMLDocument object containing this object.
Definition: SBase.cpp:3142
unsigned int getLevel() const
Returns the SBML Level of the SBMLDocument object containing this object.
Definition: SBase.cpp:3127