libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
FluxObjective.h File Reference

Definition of FluxObjective_t, the SBase_t derived class of the fbc package. More...

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

Functions

FluxObjective_tFluxObjective_clone (FluxObjective_t *fo)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
FluxObjective_tFluxObjective_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tFluxObjective_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.
 
void FluxObjective_free (FluxObjective_t *fo)
 _tFrees_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
double FluxObjective_getCoefficient (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
const char * FluxObjective_getId (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
const char * FluxObjective_getName (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
const char * FluxObjective_getReaction (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
const char * FluxObjective_getReaction2 (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
FbcVariableType_t FluxObjective_getVariableType (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
char * FluxObjective_getVariableTypeAsString (const FluxObjective_t *fo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
int FluxObjective_hasRequiredAttributes (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int FluxObjective_isSetCoefficient (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_tcoefficient_t" _tis_t _tset_t.
 
int FluxObjective_isSetId (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFluxObjective_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int FluxObjective_isSetName (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.
 
int FluxObjective_isSetReaction (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_treaction_t" _tis_t _tset_t.
 
int FluxObjective_isSetReaction2 (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_treaction2_t" _tis_t _tset_t.
 
int FluxObjective_isSetVariableType (const FluxObjective_t *fo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFluxObjective_t_t'_ts_t "_tvariableType_t" _tattribute_t _tis_t _tset_t.
 
int FluxObjective_setCoefficient (FluxObjective_t *fo, double coefficient)
 _tSets_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_setId (FluxObjective_t *fo, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
int FluxObjective_setName (FluxObjective_t *fo, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_setReaction (FluxObjective_t *fo, const char *reaction)
 _tSets_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_setReaction2 (FluxObjective_t *fo, const char *reaction)
 _tSets_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_setVariableType (FluxObjective_t *fo, FbcVariableType_t variableType)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
int FluxObjective_setVariableTypeAsString (FluxObjective_t *fo, const char *variableType)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
int FluxObjective_unsetCoefficient (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_unsetId (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
int FluxObjective_unsetName (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_unsetReaction (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_unsetReaction2 (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.
 
int FluxObjective_unsetVariableType (FluxObjective_t *fo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.
 
FluxObjective_tListOfFluxObjectives_getById (ListOf_t *lo, const char *sid)
 _tReturn_t _tthe_t _tstructure_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
FluxObjective_tListOfFluxObjectives_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Definition of FluxObjective_t, the SBase_t derived class of the fbc package.

Author
Frank T. Bergmann

Function Documentation

◆ FluxObjective_clone()

FluxObjective_t * FluxObjective_clone ( FluxObjective_t fo)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturns_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_create()

FluxObjective_t * FluxObjective_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tFluxObjective_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.

@_tparam_t _tlevel_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tlevel_t _tto_t _tassign_t _tto_t _tthis_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tversion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tversion_t _tto_t _tassign_t _tto_t _tthis_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tversion_t _tof_t _tthe_t _tpackage_t _tto_t _tassign_t _tto_t _tthis_t _tFluxObjective_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tFluxObjective_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tan_t _terror_t _toccurred_t _tduring_t _tconstruction_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_free()

void FluxObjective_free ( FluxObjective_t fo)

_tFrees_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getCoefficient()

double FluxObjective_getCoefficient ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _tcoefficient_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getId()

const char * FluxObjective_getId ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getName()

const char * FluxObjective_getName ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getReaction()

const char * FluxObjective_getReaction ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _treaction_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getReaction2()

const char * FluxObjective_getReaction2 ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t _tthe_t _treaction_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getVariableType()

FbcVariableType_t FluxObjective_getVariableType ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t _twhose_t _tvariableType_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t _tas_t _ta_t _tFbcVariableType_t_t.

@_tcopydetails_t _tdoc_fluxobjective_variableType_t @_tif_t _tclike_t _tThe_t _tvalue_t _tis_t _tdrawn_t _tfrom_t _tthe_t _tenumeration_t @_tref_t _tFbcVariableType_t_t @_tendif_t _tThe_t _tpossible_t _tvalues_t _treturned_t _tby_t _tthis_t _tmethod_t _tare_t: @_tli_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_LINEAR_t, _tFbcVariableType_t_t} @_tli_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_QUADRATIC_t, _tFbcVariableType_t_t} @_tli_t @_tsbmlconstant_t{_tFBC_VARIABLE_TYPE_INVALID_t, _tFbcVariableType_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_getVariableTypeAsString()

char * FluxObjective_getVariableTypeAsString ( const FluxObjective_t fo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t _twhose_t _tvariableType_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t _tas_t _ta_t _tconst_t _tchar_t *.

@_tcopydetails_t _tdoc_returned_unowned_char_t

@_tcopydetails_t _tdoc_fluxobjective_variableType_t _tThe_t _tpossible_t _tvalues_t _treturned_t _tby_t _tthis_t _tmethod_t _tare_t: @_tli_t @_tc_t "_tlinear_t" @_tli_t @_tc_t "_tquadratic_t" @_tli_t @_tc_t "_tinvalid_t _tFbcVariableType_t _tvalue_t"

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_hasRequiredAttributes()

int FluxObjective_hasRequiredAttributes ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetCoefficient()

int FluxObjective_isSetCoefficient ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_tcoefficient_t" _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcoefficient_t" _tof_t _tthis_t _tFluxObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetId()

int FluxObjective_isSetId ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFluxObjective_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tof_t _tthis_t _tFluxObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetName()

int FluxObjective_isSetName ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tof_t _tthis_t _tFluxObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetReaction()

int FluxObjective_isSetReaction ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_treaction_t" _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_treaction_t" _tof_t _tthis_t _tFluxObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetReaction2()

int FluxObjective_isSetReaction2 ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t'_ts_t "_treaction2_t" _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_treaction2_t" _tof_t _tthis_t _tFluxObjective_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_isSetVariableType()

int FluxObjective_isSetVariableType ( const FluxObjective_t fo)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFluxObjective_t_t'_ts_t "_tvariableType_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFluxObjective_t_t'_ts_t "_tvariableType_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tcopydetails_t _tdoc_fluxobjective_variableType_t

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setCoefficient()

int FluxObjective_setCoefficient ( FluxObjective_t fo,
double  coefficient 
)

_tSets_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tcoefficient_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tcoefficient_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setId()

int FluxObjective_setId ( FluxObjective_t fo,
const char *  id 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tid_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tid_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setName()

int FluxObjective_setName ( FluxObjective_t fo,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tname_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tFluxObjective_unsetName_t().

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tname_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tname_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tname_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setReaction()

int FluxObjective_setReaction ( FluxObjective_t fo,
const char *  reaction 
)

_tSets_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _treaction_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tFluxObjective_unsetReaction_t().

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _treaction_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_treaction_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _treaction_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction_t" _tattribute_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setReaction2()

int FluxObjective_setReaction2 ( FluxObjective_t fo,
const char *  reaction 
)

_tSets_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _treaction_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tFluxObjective_unsetReaction_t().

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _treaction_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_treaction2_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _treaction_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction2_t" _tattribute_t.

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setVariableType()

int FluxObjective_setVariableType ( FluxObjective_t fo,
FbcVariableType_t  variableType 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tvariableType_t _tFbcVariableType_t_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tto_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_fluxobjective_variableType_t

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_setVariableTypeAsString()

int FluxObjective_setVariableTypeAsString ( FluxObjective_t fo,
const char *  variableType 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tvariableType_t _tconst_t _tchar_t * _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tto_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_fluxobjective_variableType_t

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetCoefficient()

int FluxObjective_unsetCoefficient ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcoefficient_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetId()

int FluxObjective_unsetId ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetName()

int FluxObjective_unsetName ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetReaction()

int FluxObjective_unsetReaction ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetReaction2()

int FluxObjective_unsetReaction2 ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treaction2_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFluxObjective_t_t _tstructure_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFluxObjective_t_t

◆ FluxObjective_unsetVariableType()

int FluxObjective_unsetVariableType ( FluxObjective_t fo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariableType_t" _tattribute_t _tof_t _tthis_t _tFluxObjective_t_t.

@_tparam_t _tfo_t _tthe_t _tFluxObjective_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_fluxobjective_variableType_t

@_tmemberof_t _tFluxObjective_t_t

◆ ListOfFluxObjectives_getById()

FluxObjective_t * ListOfFluxObjectives_getById ( ListOf_t lo,
const char *  sid 
)

_tReturn_t _tthe_t _tstructure_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _ta_t _tstring_t _tmatching_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _telement_t _tsought_t.

@_treturn_t _tthe_t _tstructure_t _tfor_t _tthe_t _tgiven_t _tvariable_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t _tin_t _tthe_t _tlist_t.

@_tmemberof_t _tFluxObjective_t_t

◆ ListOfFluxObjectives_removeById()

FluxObjective_t * ListOfFluxObjectives_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tsought_t _tstructure_t.

@_treturn_t _tthe_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _tstructure_t _twith_t _tthe_t "_tid_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

@_tmemberof_t _tFluxObjective_t_t