libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
FbcExtension.h File Reference

Definition of FbcExtension_t, the core module of fbc package. More...

Include dependency graph for FbcExtension.h:
This graph shows which files directly or indirectly include this file:

Enumerations

enum  FbcVariableType_t {
  FBC_VARIABLE_TYPE_LINEAR ,
  FBC_VARIABLE_TYPE_QUADRATIC ,
  FBC_VARIABLE_TYPE_INVALID
}
 @_tenum_t _tFbcVariableType_t_t @_tbrief_t _tEnumeration_t _tof_t _tvalues_t _tpermitted_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_tfbcvariabletype_t" _tattribute_t _ton_t _tFbc_t _tobjects_t. More...
 
enum  SBMLFbcTypeCode_t {
  SBML_FBC_V1ASSOCIATION = 800 ,
  SBML_FBC_FLUXBOUND = 801 ,
  SBML_FBC_FLUXOBJECTIVE = 802 ,
  SBML_FBC_GENEASSOCIATION = 803 ,
  SBML_FBC_OBJECTIVE = 804 ,
  SBML_FBC_ASSOCIATION = 805 ,
  SBML_FBC_GENEPRODUCTASSOCIATION = 806 ,
  SBML_FBC_GENEPRODUCT = 807 ,
  SBML_FBC_GENEPRODUCTREF = 808 ,
  SBML_FBC_AND = 809 ,
  SBML_FBC_OR = 810 ,
  SBML_FBC_USERDEFINEDCONSTRAINTCOMPONENT = 811 ,
  SBML_FBC_USERDEFINEDCONSTRAINT = 812 ,
  SBML_FBC_KEYVALUEPAIR = 813
}
 @_tenum_t _tSBMLFbcTypeCode_t_t @_tbrief_t _tSBMLFbcTypeCode_t_t _tEnumeration_t _tof_t _tpossible_t _ttypes_t _tin_t _tthe_t _tlibSBML_t &_tldquo_t;_tfbc_t&_trdquo_t; _tpackage_t _timplementation_t. More...
 

Functions

FbcVariableType_t FbcVariableType_fromString (const char *code)
 _tReturns_t _tthe_t #_tFbcVariableType_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t _tor_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.
 
int FbcVariableType_isValid (FbcVariableType_t fvt)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t #_tFbcVariableType_t_t _tis_t _tvalid_t.
 
int FbcVariableType_isValidString (const char *code)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t #_tFbcVariableType_t_t.
 
const char * FbcVariableType_toString (FbcVariableType_t fvt)
 _tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tFbcVariableType_t_t _tenumeration_t.
 

Detailed Description

Definition of FbcExtension_t, the core module of fbc package.

Author
Frank T. Bergmann

Enumeration Type Documentation

◆ FbcVariableType_t

@_tenum_t _tFbcVariableType_t_t @_tbrief_t _tEnumeration_t _tof_t _tvalues_t _tpermitted_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_tfbcvariabletype_t" _tattribute_t _ton_t _tFbc_t _tobjects_t.

@_tif_t _tconly_t @_tsee_t _tFbc_getFbcvariabletype_t() @_tsee_t _tFbc_setFbcvariabletype_t() @_telseif_t _tjava_t @_tsee_t _tFbc_t::_tgetFbcvariabletype_t() @_tsee_t _tFbc_t::_tsetFbcvariabletype_t(_tlong_t) @_telse_t @_tsee_t _tFbc_t::_tgetFbcvariabletype_t() @_tsee_t _tFbc_t::_tsetFbcvariabletype_t() @_tendif_t

Enumerator
FBC_VARIABLE_TYPE_LINEAR 

The fbc fbcvariabletype is "linear".

FBC_VARIABLE_TYPE_QUADRATIC 

The fbc fbcvariabletype is "quadratic".

FBC_VARIABLE_TYPE_INVALID 

Invalid FbcVariableType value.

◆ SBMLFbcTypeCode_t

@_tenum_t _tSBMLFbcTypeCode_t_t @_tbrief_t _tSBMLFbcTypeCode_t_t _tEnumeration_t _tof_t _tpossible_t _ttypes_t _tin_t _tthe_t _tlibSBML_t &_tldquo_t;_tfbc_t&_trdquo_t; _tpackage_t _timplementation_t.

@_tcopydetails_t _tdoc_what_are_typecodes_t

@_tcopydetails_t _tdoc_additional_typecode_details_t

Enumerator
SBML_FBC_V1ASSOCIATION 

Association (only used in Version 1; replaced in Version 2 with FbcAssociation)

SBML_FBC_FLUXBOUND 

FluxBound

SBML_FBC_FLUXOBJECTIVE 

FluxObjective

SBML_FBC_GENEASSOCIATION 

GeneAssociation (only used in Version 1; replaced in Version 2 with GeneProductAssociation)

SBML_FBC_OBJECTIVE 

Objective

SBML_FBC_ASSOCIATION 

FbcAssociation

SBML_FBC_GENEPRODUCTASSOCIATION 

GeneProductAssociation

SBML_FBC_GENEPRODUCT 

GeneProduct

SBML_FBC_GENEPRODUCTREF 

GeneProductRef

SBML_FBC_AND 

FbcAnd

SBML_FBC_OR 

FbcOr

SBML_FBC_USERDEFINEDCONSTRAINTCOMPONENT 

UserDefinedConstraintComponent

SBML_FBC_USERDEFINEDCONSTRAINT 

UserDefinedConstraint

SBML_FBC_KEYVALUEPAIR 

KeyValuePair

Function Documentation

◆ FbcVariableType_fromString()

FbcVariableType_t FbcVariableType_fromString ( const char *  code)

_tReturns_t _tthe_t #_tFbcVariableType_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t _tor_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.

@_tparam_t _tcode_t _tthe_t _tstring_t _tto_t _tconvert_t _tto_t _ta_t #_tFbcVariableType_t_t.

@_treturn_t _tthe_t _tcorresponding_t #_tFbcVariableType_t_t _tor_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t} _tif_t _tno_t _tmatch_t _tis_t _tfound_t.

@_tnote_t _tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tlinear_t" _twill_t _treturn_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_LINEAR_t, _tFbcVariableType_t_t}, _tbut_t "_tLinear_t" _twill_t _treturn_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t}.

@_tif_t _tconly_t @_tmemberof_t _tFbc_t_t @_tendif_t

◆ FbcVariableType_isValid()

int FbcVariableType_isValid ( FbcVariableType_t  fvt)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t #_tFbcVariableType_t_t _tis_t _tvalid_t.

@_tparam_t _tfvt_t _tthe_t #_tFbcVariableType_t_t _tenumeration_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t #_tFbcVariableType_t_t _tis_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_LINEAR_t, _tFbcVariableType_t_t}, _tor_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_QUADRATIC_t, _tFbcVariableType_t_t}; @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t}).

@_tif_t _tconly_t @_tmemberof_t _tFbc_t_t @_tendif_t

◆ FbcVariableType_isValidString()

int FbcVariableType_isValidString ( const char *  code)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t #_tFbcVariableType_t_t.

@_tparam_t _tcode_t _tthe_t _tstring_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tis_t "_tlinear_t", "_tquadratic_t", _tor_t "_tinvalid_t _tFbcVariableType_t _tvalue_t"; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tlinear_t" _twill_t _treturn_t @_tc_t _t1_t (_ttrue_t), _tbut_t "_tLinear_t" _twill_t _treturn_t @_tc_t _t0_t (_tfalse_t).

@_tif_t _tconly_t @_tmemberof_t _tFbc_t_t @_tendif_t

◆ FbcVariableType_toString()

const char * FbcVariableType_toString ( FbcVariableType_t  fvt)

_tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tFbcVariableType_t_t _tenumeration_t.

@_tparam_t _tfvt_t _tthe_t #_tFbcVariableType_t_t _tenumeration_t _tvalue_t _tto_t _tconvert_t.

@_treturn_t _tA_t _tstring_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _ttype_t: "_tlinear_t", "_tquadratic_t", "_tinvalid_t _tFbcVariableType_t _tvalue_t", _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t} _tor_t _tanother_t _tinvalid_t _tenumeration_t _tvalue_t.

@_tcopydetails_t _tdoc_returned_unowned_char_t

@_tif_t _tconly_t @_tmemberof_t _tFbc_t_t @_tendif_t