libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
FbcSpeciesPlugin.cpp File Reference

Implementation of FbcSpeciesPlugin_t, the plugin class of the fbc package for the Species_t element. More...

Include dependency graph for FbcSpeciesPlugin.cpp:

Functions

int FbcSpeciesPlugin_getCharge (FbcSBasePlugin_t *fbc)
 @_tcond_t _tdoxygenIgnored_t
 
double FbcSpeciesPlugin_getChargeAsDouble (FbcSBasePlugin_t *fbc)
 _tTakes_t _ta_t _tFbcSpeciesPlugin_t_t _tstructure_t _tand_t _treturns_t _tits_t _tcharge_t.
 
char * FbcSpeciesPlugin_getChemicalFormula (FbcSBasePlugin_t *fbc)
 _tTakes_t _ta_t _tFbcSpeciesPlugin_t_t _tstructure_t _tand_t _treturns_t _tits_t _tchemicalFormula_t.
 
int FbcSpeciesPlugin_isSetCharge (FbcSBasePlugin_t *fbc)
 _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 _tFbcSpeciesPlugin_t_t _tstructure_t'_ts_t _tcharge_t _tis_t _tset_t.
 
int FbcSpeciesPlugin_isSetChemicalFormula (FbcSBasePlugin_t *fbc)
 _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 _tFbcSpeciesPlugin_t_t _tstructure_t'_ts_t _tchemicalFormula_t _tis_t _tset_t.
 
int FbcSpeciesPlugin_setCharge (FbcSBasePlugin_t *fbc, int charge)
 _tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.
 
int FbcSpeciesPlugin_setChargeAsDouble (FbcSBasePlugin_t *fbc, double charge)
 _tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.
 
int FbcSpeciesPlugin_setChemicalFormula (FbcSBasePlugin_t *fbc, const char *chemform)
 _tSets_t _tthe_t _tchemicalFormula_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tchemicalFormula_t.
 
int FbcSpeciesPlugin_unsetCharge (FbcSBasePlugin_t *fbc)
 _tUnsets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.
 
int FbcSpeciesPlugin_unsetChemicalFormula (FbcSBasePlugin_t *fbc)
 _tUnsets_t _tthe_t "_tchemicalFormula_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.
 

Detailed Description

Implementation of FbcSpeciesPlugin_t, the plugin class of the fbc package for the Species_t element.

Author
Frank T. Bergmann

Function Documentation

◆ FbcSpeciesPlugin_getCharge()

int FbcSpeciesPlugin_getCharge ( FbcSBasePlugin_t fbc)

@_tcond_t _tdoxygenIgnored_t

_tTakes_t _ta_t _tFbcSpeciesPlugin_t_t _tstructure_t _tand_t _treturns_t _tits_t _tcharge_t.

◆ FbcSpeciesPlugin_getChargeAsDouble()

double FbcSpeciesPlugin_getChargeAsDouble ( FbcSBasePlugin_t fbc)

_tTakes_t _ta_t _tFbcSpeciesPlugin_t_t _tstructure_t _tand_t _treturns_t _tits_t _tcharge_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _twhose_t _tcharge_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tcharge_t _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t, _tas_t _tan_t @_tc_t _tdouble_t.

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_getChemicalFormula()

char * FbcSpeciesPlugin_getChemicalFormula ( FbcSBasePlugin_t fbc)

_tTakes_t _ta_t _tFbcSpeciesPlugin_t_t _tstructure_t _tand_t _treturns_t _tits_t _tchemicalFormula_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _twhose_t _tchemicalFormula_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tchemicalFormula_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_isSetCharge()

int FbcSpeciesPlugin_isSetCharge ( FbcSBasePlugin_t fbc)

_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 _tFbcSpeciesPlugin_t_t _tstructure_t'_ts_t _tcharge_t _tis_t _tset_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t _tto_t _tquery_t

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_isSetChemicalFormula()

int FbcSpeciesPlugin_isSetChemicalFormula ( FbcSBasePlugin_t fbc)

_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 _tFbcSpeciesPlugin_t_t _tstructure_t'_ts_t _tchemicalFormula_t _tis_t _tset_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t _tto_t _tquery_t

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tchemicalFormula_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_setCharge()

int FbcSpeciesPlugin_setCharge ( FbcSBasePlugin_t fbc,
int  charge 
)

_tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t

@_tparam_t _tcharge_t _tthe_t _tvalue_t _tof_t _tcharge_t _tto_t _tassign_t _tto_t _tthe_t "_tcharge_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_setChargeAsDouble()

int FbcSpeciesPlugin_setChargeAsDouble ( FbcSBasePlugin_t fbc,
double  charge 
)

_tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t

@_tparam_t _tcharge_t _tthe_t _tvalue_t _tof_t _tcharge_t _tto_t _tassign_t _tto_t _tthe_t "_tcharge_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_setChemicalFormula()

int FbcSpeciesPlugin_setChemicalFormula ( FbcSBasePlugin_t fbc,
const char *  chemicalFormula 
)

_tSets_t _tthe_t _tchemicalFormula_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tchemicalFormula_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t _tto_t _tset_t @_tparam_t _tchemicalFormula_t _tthe_t _tchemicalFormula_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t'_ts_t "_tchemicalFormula_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 "_tchemicalFormula_t" _tattribute_t.

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_unsetCharge()

int FbcSpeciesPlugin_unsetCharge ( FbcSBasePlugin_t fbc)

_tUnsets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tFbcSpeciesPlugin_t_t

◆ FbcSpeciesPlugin_unsetChemicalFormula()

int FbcSpeciesPlugin_unsetChemicalFormula ( FbcSBasePlugin_t fbc)

_tUnsets_t _tthe_t "_tchemicalFormula_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFbcSpeciesPlugin_t_t _tstructure_t.

@_tparam_t _tfbc_t _tthe_t _tFbcSpeciesPlugin_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tFbcSpeciesPlugin_t_t