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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
|
% toolbox\fbc_package\MATLAB_SBML_Structures\FluxObjective
%
% The functions allow users to create and work with the SBML FBC FluxObjective structure.
%
%==================================================================
% FluxObjective = FluxObjective_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 FluxObjective structure of the appropriate level, version and pkgVersion
%
%===============================================================
% coefficient = FluxObjective_getCoefficient(SBMLFluxObjective)
%===============================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the value of the fbc_coefficient attribute
%
%=====================================================
% metaid = FluxObjective_getMetaid(SBMLFluxObjective)
%=====================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the value of the metaid attribute
%
%=========================================================
% reaction = FluxObjective_getReaction(SBMLFluxObjective)
%=========================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the value of the fbc_reaction attribute
%
%=======================================================
% sboTerm = FluxObjective_getSBOTerm(SBMLFluxObjective)
%=======================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the value of the sboTerm attribute
%
%=================================================================
% coefficient = FluxObjective_isSetCoefficient(SBMLFluxObjective)
%=================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. value =
% - 1 if the fbc_coefficient attribute is set
% - 0 otherwise
%
%=======================================================
% metaid = FluxObjective_isSetMetaid(SBMLFluxObjective)
%=======================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. value =
% - 1 if the metaid attribute is set
% - 0 otherwise
%
%===========================================================
% reaction = FluxObjective_isSetReaction(SBMLFluxObjective)
%===========================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. value =
% - 1 if the fbc_reaction attribute is set
% - 0 otherwise
%
%=========================================================
% sboTerm = FluxObjective_isSetSBOTerm(SBMLFluxObjective)
%=========================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. value =
% - 1 if the sboTerm attribute is set
% - 0 otherwise
%
%==================================================================================
% SBMLFluxObjective = FluxObjective_setCoefficient(SBMLFluxObjective, coefficient)
%==================================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% 2. coefficient, a number representing the fbc_coefficient to be set
% Returns
% 1. the SBML FBC FluxObjective structure with the new value for the fbc_coefficient attribute
%
%========================================================================
% SBMLFluxObjective = FluxObjective_setMetaid(SBMLFluxObjective, metaid)
%========================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% 2. metaid, a string representing the metaid to be set
% Returns
% 1. the SBML FBC FluxObjective structure with the new value for the metaid attribute
%
%============================================================================
% SBMLFluxObjective = FluxObjective_setReaction(SBMLFluxObjective, reaction)
%============================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% 2. reaction, a string representing the fbc_reaction to be set
% Returns
% 1. the SBML FBC FluxObjective structure with the new value for the fbc_reaction attribute
%
%==========================================================================
% SBMLFluxObjective = FluxObjective_setSBOTerm(SBMLFluxObjective, sboTerm)
%==========================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% 2. sboTerm, a number representing the sboTerm to be set
% Returns
% 1. the SBML FBC FluxObjective structure with the new value for the sboTerm attribute
%
%=======================================================================
% SBMLFluxObjective = FluxObjective_unsetCoefficient(SBMLFluxObjective)
%=======================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the SBML FBC FluxObjective structure with the fbc_coefficient attribute unset
%
%==================================================================
% SBMLFluxObjective = FluxObjective_unsetMetaid(SBMLFluxObjective)
%==================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the SBML FBC FluxObjective structure with the metaid attribute unset
%
%====================================================================
% SBMLFluxObjective = FluxObjective_unsetReaction(SBMLFluxObjective)
%====================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the SBML FBC FluxObjective structure with the fbc_reaction attribute unset
%
%===================================================================
% SBMLFluxObjective = FluxObjective_unsetSBOTerm(SBMLFluxObjective)
%===================================================================
% Takes
% 1. SBMLFluxObjective, an SBML FluxObjective structure
% Returns
% 1. the SBML FBC FluxObjective structure with the sboTerm 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.
%----------------------------------------------------------------------- -->
|