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

Definition of FbcModelPlugin_t, the plugin class of fbc package for the Model_t element. More...

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

Functions

int FbcModelPlugin_addFluxBound (SBasePlugin_t *fmp, FluxBound_t *fb)
 _tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxBound_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.
 
int FbcModelPlugin_addGeneProduct (SBasePlugin_t *fmp, GeneProduct_t *fb)
 _tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProduct_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.
 
int FbcModelPlugin_addObjective (SBasePlugin_t *fmp, Objective_t *obj)
 _tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.
 
int FbcModelPlugin_addUserDefinedConstraint (FbcModelPlugin_t *fmp, const UserDefinedConstraint_t *udc)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUserDefinedConstraint_t_t _tto_t _tthis_t _tFbcModelPlugin_t_t.
 
GeneProduct_tFbcModelPlugin_createGeneProduct (SBasePlugin_t *fmp)
 _tCreates_t _ta_t _tnew_t _tGeneProduct_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tcreated_t _tobject_t.
 
Objective_tFbcModelPlugin_createObjective (SBasePlugin_t *fmp)
 _tCreates_t _ta_t _tnew_t _tObjective_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tcreated_t _tobject_t.
 
UserDefinedConstraint_tFbcModelPlugin_createUserDefinedConstraint (FbcModelPlugin_t *fmp)
 _tCreates_t _ta_t _tnew_t _tUserDefinedConstraint_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tcreated_t.
 
char * FbcModelPlugin_getActiveObjectiveId (SBasePlugin_t *fmp)
 _tTakes_t _ta_t _tFbcModelPlugin_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tid_t _tof_t _tthe_t _tcurrent_t _tactiveObjective_t.
 
FluxBound_tFbcModelPlugin_getFluxBound (SBasePlugin_t *fmp, unsigned int n)
 _tReturn_t _ta_t _tspecific_t _tFluxBound_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
GeneProduct_tFbcModelPlugin_getGeneProduct (SBasePlugin_t *fmp, unsigned int n)
 _tReturn_t _ta_t _tspecific_t _tGeneProduct_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
ListOf_tFbcModelPlugin_getListOfUserDefinedConstraints (FbcModelPlugin_t *fmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tUserDefinedConstraint_t_t _tobjects_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t.
 
unsigned int FbcModelPlugin_getNumFluxBounds (SBasePlugin_t *fmp)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tFluxBound_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
unsigned int FbcModelPlugin_getNumGeneProducts (SBasePlugin_t *fmp)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tGeneProduct_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
unsigned int FbcModelPlugin_getNumObjectives (SBasePlugin_t *fmp)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tObjective_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
unsigned int FbcModelPlugin_getNumUserDefinedConstraints (FbcModelPlugin_t *fmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraint_t_t _tobjects_t _tin_t _tthis_t _tFbcModelPlugin_t_t.
 
Objective_tFbcModelPlugin_getObjective (SBasePlugin_t *fmp, unsigned int n)
 _tReturn_t _ta_t _tspecific_t _tObjective_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 
int FbcModelPlugin_getStrict (SBasePlugin_t *fmp)
 _tTakes_t _ta_t _tFbcModelPlugin_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tstrict_t _tattribute_t.
 
UserDefinedConstraint_tFbcModelPlugin_getUserDefinedConstraint (FbcModelPlugin_t *fmp, unsigned int n)
 _tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t.
 
UserDefinedConstraint_tFbcModelPlugin_getUserDefinedConstraintById (FbcModelPlugin_t *fmp, const char *sid)
 _tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
UserDefinedConstraint_tFbcModelPlugin_getUserDefinedConstraintByLowerBound (FbcModelPlugin_t *fmp, const char *sid)
 _tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tLowerBound_t _tto_t _twhich_t _tit_t _trefers_t.
 
UserDefinedConstraint_tFbcModelPlugin_getUserDefinedConstraintByUpperBound (FbcModelPlugin_t *fmp, const char *sid)
 _tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tUpperBound_t _tto_t _twhich_t _tit_t _trefers_t.
 
UserDefinedConstraint_tFbcModelPlugin_removeUserDefinedConstraint (FbcModelPlugin_t *fmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tUserDefinedConstraint_t_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
UserDefinedConstraint_tFbcModelPlugin_removeUserDefinedConstraintById (FbcModelPlugin_t *fmp, const char *sid)
 _tRemoves_t _tthe_t _tUserDefinedConstraint_t_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int FbcModelPlugin_setActiveObjectiveId (SBasePlugin_t *fmp, const char *activeObjective)
 _tSets_t _tthe_t _tactiveObjective_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tactiveObjective_t.
 
int FbcModelPlugin_setStrict (SBasePlugin_t *fmp, int strict)
 _tSets_t _tthe_t _tstrict_t _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.
 

Detailed Description

Definition of FbcModelPlugin_t, the plugin class of fbc package for the Model_t element.

Author
Frank T. Bergmann

Function Documentation

◆ FbcModelPlugin_addFluxBound()

int FbcModelPlugin_addFluxBound ( SBasePlugin_t fbc,
FluxBound_t fb 
)

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxBound_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tFluxBound_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tfb_t _ta_t _tFluxBound_t_t _tstructure_t _tto_t _tadd_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcModelPlugin_t_t

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFluxBound_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.

◆ FbcModelPlugin_addGeneProduct()

int FbcModelPlugin_addGeneProduct ( SBasePlugin_t fmp,
GeneProduct_t fb 
)

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGeneProduct_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tGeneProduct_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tfb_t _ta_t _tGeneProduct_t_t _tstructure_t _tto_t _tadd_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_addObjective()

int FbcModelPlugin_addObjective ( SBasePlugin_t fmp,
Objective_t obj 
)

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tObjective_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tstructure_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tObjective_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tobj_t _tan_t _tObjective_t_t _tstructure_t _tto_t _tadd_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_addUserDefinedConstraint()

int FbcModelPlugin_addUserDefinedConstraint ( FbcModelPlugin_t fmp,
const UserDefinedConstraint_t udc 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUserDefinedConstraint_t_t _tto_t _tthis_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tUserDefinedConstraint_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tudc_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tto_t _tadd_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_createGeneProduct()

GeneProduct_t * FbcModelPlugin_createGeneProduct ( SBasePlugin_t fmp)

_tCreates_t _ta_t _tnew_t _tGeneProduct_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tcreated_t _tobject_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tGeneProduct_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tGeneProduct_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_createObjective()

Objective_t * FbcModelPlugin_createObjective ( SBasePlugin_t fmp)

_tCreates_t _ta_t _tnew_t _tObjective_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tcreated_t _tobject_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tObjective_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tObjective_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_createUserDefinedConstraint()

UserDefinedConstraint_t * FbcModelPlugin_createUserDefinedConstraint ( FbcModelPlugin_t fmp)

_tCreates_t _ta_t _tnew_t _tUserDefinedConstraint_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tcreated_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tUserDefinedConstraint_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tUserDefinedConstraint_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getActiveObjectiveId()

char * FbcModelPlugin_getActiveObjectiveId ( SBasePlugin_t fmp)

_tTakes_t _ta_t _tFbcModelPlugin_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tid_t _tof_t _tthe_t _tcurrent_t _tactiveObjective_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _twhose_t _tid_t _tof_t _tthe_t _tcurrent_t _tactiveObjective_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthe_t _tcurrent_t _tactiveObjective_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getFluxBound()

FluxBound_t * FbcModelPlugin_getFluxBound ( SBasePlugin_t fmp,
unsigned int  n 
)

_tReturn_t _ta_t _tspecific_t _tFluxBound_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tn_t _tan_t _tinteger_t, _tthe_t _tindex_t _tof_t _tthe_t _tFluxBound_t_t _tstructure_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tnth_t _tFluxBound_t_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tFluxBound_t_t _texists_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getGeneProduct()

GeneProduct_t * FbcModelPlugin_getGeneProduct ( SBasePlugin_t fmp,
unsigned int  n 
)

_tReturn_t _ta_t _tspecific_t _tGeneProduct_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tn_t _tan_t _tinteger_t, _tthe_t _tindex_t _tof_t _tthe_t _tGeneProduct_t_t _tstructure_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tnth_t _tGeneProduct_t_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tGeneProduct_t_t _texists_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getListOfUserDefinedConstraints()

ListOf_t * FbcModelPlugin_getListOfUserDefinedConstraints ( FbcModelPlugin_t fmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tUserDefinedConstraint_t_t _tobjects_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _twhose_t _tListOfUserDefinedConstraints_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfUserDefinedConstraints_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tFbcModelPlugin_addUserDefinedConstraint_t() @_tsee_t _tFbcModelPlugin_createUserDefinedConstraint_t() @_tsee_t _tFbcModelPlugin_getUserDefinedConstraintById_t() @_tsee_t _tFbcModelPlugin_getUserDefinedConstraint_t() @_tsee_t _tFbcModelPlugin_getNumUserDefinedConstraints_t() @_tsee_t _tFbcModelPlugin_removeUserDefinedConstraintById_t() @_tsee_t _tFbcModelPlugin_removeUserDefinedConstraint_t()

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getNumFluxBounds()

unsigned int FbcModelPlugin_getNumFluxBounds ( SBasePlugin_t fmp)

_tReturns_t _tthe_t _tnumber_t _tof_t _tFluxBound_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tFluxBound_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getNumGeneProducts()

unsigned int FbcModelPlugin_getNumGeneProducts ( SBasePlugin_t fmp)

_tReturns_t _tthe_t _tnumber_t _tof_t _tGeneProduct_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tGeneProduct_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getNumObjectives()

unsigned int FbcModelPlugin_getNumObjectives ( SBasePlugin_t fmp)

_tReturns_t _tthe_t _tnumber_t _tof_t _tObjective_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tObjective_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getNumUserDefinedConstraints()

unsigned int FbcModelPlugin_getNumUserDefinedConstraints ( FbcModelPlugin_t fmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraint_t_t _tobjects_t _tin_t _tthis_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tUserDefinedConstraint_t_t _tobjects_t _tin_t _tthis_t _tFbcModelPlugin_t_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getObjective()

Objective_t * FbcModelPlugin_getObjective ( SBasePlugin_t fmp,
unsigned int  n 
)

_tReturn_t _ta_t _tspecific_t _tObjective_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tn_t _tan_t _tinteger_t, _tthe_t _tindex_t _tof_t _tthe_t _tObjective_t_t _tstructure_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tnth_t _tObjective_t_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tObjective_t_t _texists_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getStrict()

int FbcModelPlugin_getStrict ( SBasePlugin_t fmp)

_tTakes_t _ta_t _tFbcModelPlugin_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tthe_t _tstrict_t _tattribute_t.

@_tcopydetails_t _tdoc_note_strict_v2_only_t

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _twhose_t '_tstrict_t' _tattribute_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthe_t _tcurrent_t _tactiveObjective_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getUserDefinedConstraint()

UserDefinedConstraint_t * FbcModelPlugin_getUserDefinedConstraint ( FbcModelPlugin_t fmp,
unsigned int  n 
)

_tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tUserDefinedConstraint_t_t _tin_t _tthe_t _tListOfUserDefinedConstraints_t _twithin_t _tthis_t _tFbcModelPlugin_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getUserDefinedConstraintById()

UserDefinedConstraint_t * FbcModelPlugin_getUserDefinedConstraintById ( FbcModelPlugin_t fmp,
const char *  sid 
)

_tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tUserDefinedConstraint_t_t _tin_t _tthe_t _tListOfUserDefinedConstraints_t _twithin_t _tthis_t _tFbcModelPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraint_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getUserDefinedConstraintByLowerBound()

UserDefinedConstraint_t * FbcModelPlugin_getUserDefinedConstraintByLowerBound ( FbcModelPlugin_t fmp,
const char *  sid 
)

_tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tLowerBound_t _tto_t _twhich_t _tit_t _trefers_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t "_tlowerBound_t" _tattribute_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tfirst_t _tUserDefinedConstraint_t_t _tin_t _tthis_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tgiven_t _tlowerBound_t _tattribute_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraint_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_getUserDefinedConstraintByUpperBound()

UserDefinedConstraint_t * FbcModelPlugin_getUserDefinedConstraintByUpperBound ( FbcModelPlugin_t fmp,
const char *  sid 
)

_tGet_t _tan_t _tUserDefinedConstraint_t_t _tfrom_t _tthe_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tUpperBound_t _tto_t _twhich_t _tit_t _trefers_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t "_tupperBound_t" _tattribute_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tobject_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tfirst_t _tUserDefinedConstraint_t_t _tin_t _tthis_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tgiven_t _tupperBound_t _tattribute_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraint_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_removeUserDefinedConstraint()

UserDefinedConstraint_t * FbcModelPlugin_removeUserDefinedConstraint ( FbcModelPlugin_t fmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tUserDefinedConstraint_t_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tUserDefinedConstraint_t_t _tin_t _tthis_t _tFbcModelPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_removeUserDefinedConstraintById()

UserDefinedConstraint_t * FbcModelPlugin_removeUserDefinedConstraintById ( FbcModelPlugin_t fmp,
const char *  sid 
)

_tRemoves_t _tthe_t _tUserDefinedConstraint_t_t _tfrom_t _tthis_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tUserDefinedConstraint_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tUserDefinedConstraint_t_t _tin_t _tthis_t _tFbcModelPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tUserDefinedConstraint_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_setActiveObjectiveId()

int FbcModelPlugin_setActiveObjectiveId ( SBasePlugin_t fmp,
const char *  activeObjective 
)

_tSets_t _tthe_t _tactiveObjective_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tactiveObjective_t.

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tactiveObjective_t _tthe_t _tactiveObjective_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t'_ts_t "_tactiveObjective_t" _tattribute_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tactiveObjective_t" _tattribute_t.

@_tmemberof_t _tFbcModelPlugin_t_t

◆ FbcModelPlugin_setStrict()

int FbcModelPlugin_setStrict ( SBasePlugin_t fmp,
int  strict 
)

_tSets_t _tthe_t _tstrict_t _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcModelPlugin_t_t.

@_tcopydetails_t _tdoc_note_strict_v2_only_t

@_tparam_t _tfmp_t _tthe_t _tFbcModelPlugin_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tstrict_t _tbool_t _tvalue_t _tof_t _tthe_t "_tstrict_t" _tattribute_t _tto_t _tbe_t _tset_t, _twith_t @_tc_t _t0_t _tindicating_t '_tfalse_t', _tand_t _tall_t _tother_t _tvalues_t _tindicating_t '_ttrue_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}

@_tmemberof_t _tFbcModelPlugin_t_t