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
|
% toolbox\fbc_package\MATLAB_SBML_Structures\FBCModel
%
% The functions allow users to create and work with the FBC elements
% and attributes of an SBML FBC Model structure.
%
%===================================================================
% SBMLFBCModel = FBCModel_addFluxBound(SBMLFBCModel, SBMLFluxBound)
%===================================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% 2. SBMLFluxBound, an SBML FluxBound structure
% Returns
% 1. the SBML FBCModel structure with the SBML FluxBound structure added
%
%===================================================================
% SBMLFBCModel = FBCModel_addObjective(SBMLFBCModel, SBMLObjective)
%===================================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% 2. SBMLObjective, an SBML Objective structure
% Returns
% 1. the SBML FBCModel structure with the SBML Objective structure added
%
%========================================================
% FBCModel = FBCModel_create(level, version, pkgVersion)
%========================================================
% Takes
% 1. level, an integer representing an SBML level
% 2. version, an integer representing an SBML version
% 3. pkgVersion, an integer representing an SBML package version
% Returns
% 1. a MATLAB_SBML FBC FBCModel structure of the appropriate level, version and pkgVersion
%
%=======================================================
% SBMLFBCModel = FBCModel_createFluxBound(SBMLFBCModel)
%=======================================================
% Takes
% 1. FBCModel, an SBML FBCModel structure
% Returns
% 1. the SBML FBCModel structure with a new SBML FluxBound structure added
%
%=======================================================
% SBMLFBCModel = FBCModel_createObjective(SBMLFBCModel)
%=======================================================
% Takes
% 1. FBCModel, an SBML FBCModel structure
% Returns
% 1. the SBML FBCModel structure with a new SBML Objective structure added
%
%=============================================================
% activeObjective = FBCModel_getActiveObjective(SBMLFBCModel)
%=============================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. the value of the fbc_activeObjective attribute
%
%========================================================
% fluxBound = FBCModel_getFluxBound(SBMLFBCModel, index)
%========================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% 2. index, an integer representing the index of SBML FluxBound structure
% Returns
% 1. the SBML FluxBound structure at the indexed position
%
%========================================================
% fluxBound = FBCModel_getListOfFluxBounds(SBMLFBCModel)
%========================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. an array of the fluxBound structures
%
%========================================================
% objective = FBCModel_getListOfObjectives(SBMLFBCModel)
%========================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. an array of the objective structures
%
%===============================================
% num = FBCModel_getNumFluxBounds(SBMLFBCModel)
%===============================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. the number of SBML FluxBound structures present in the FBCModel
%
%===============================================
% num = FBCModel_getNumObjectives(SBMLFBCModel)
%===============================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. the number of SBML Objective structures present in the FBCModel
%
%========================================================
% objective = FBCModel_getObjective(SBMLFBCModel, index)
%========================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% 2. index, an integer representing the index of SBML Objective structure
% Returns
% 1. the SBML Objective structure at the indexed position
%
%===============================================================
% activeObjective = FBCModel_isSetActiveObjective(SBMLFBCModel)
%===============================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. value =
% - 1 if the fbc_activeObjective attribute is set
% - 0 otherwise
%
%===========================================================================
% SBMLFBCModel = FBCModel_setActiveObjective(SBMLFBCModel, activeObjective)
%===========================================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% 2. activeObjective, a string representing the fbc_activeObjective to be set
% Returns
% 1. the SBML FBC FBCModel structure with the new value for the fbc_activeObjective attribute
%
%============================================================
% SBMLFBCModel = FBCModel_unsetActiveObjective(SBMLFBCModel)
%============================================================
% Takes
% 1. SBMLFBCModel, an SBML FBCModel structure
% Returns
% 1. the SBML FBC FBCModel structure with the fbc_activeObjective attribute unset
%
%<!---------------------------------------------------------------------------
% This file is part of SBMLToolbox. Please visit http://sbml.org for more
% information about SBML, and the latest version of SBMLToolbox.
%
% Copyright (C) 2009-2012 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. EMBL European Bioinformatics Institute (EBML-EBI), Hinxton, UK
%
% Copyright (C) 2006-2008 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. University of Hertfordshire, Hatfield, UK
%
% Copyright (C) 2003-2005 jointly by the following organizations:
% 1. California Institute of Technology, Pasadena, CA, USA
% 2. Japan Science and Technology Agency, Japan
% 3. University of Hertfordshire, Hatfield, UK
%
% SBMLToolbox 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.
%----------------------------------------------------------------------- -->
|