libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
FbcSBasePlugin.cpp File Reference

Implementation of the FbcSBasePlugin_t class. More...

Include dependency graph for FbcSBasePlugin.cpp:

Functions

int FbcSBasePlugin_addKeyValuePair (FbcSBasePlugin_t *fsbp, const KeyValuePair_t *kvp)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKeyValuePair_t_t _tto_t _tthis_t _tFbcSBasePlugin_t_t.
 
KeyValuePair_tFbcSBasePlugin_createKeyValuePair (FbcSBasePlugin_t *fsbp)
 _tCreates_t _ta_t _tnew_t _tKeyValuePair_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tKeyValuePair_t_t _tobject_t _tcreated_t.
 
KeyValuePair_tFbcSBasePlugin_getKeyValuePair (FbcSBasePlugin_t *fsbp, unsigned int n)
 _tGet_t _ta_t _tKeyValuePair_t_t _tfrom_t _tthe_t _tFbcSBasePlugin_t_t.
 
KeyValuePair_tFbcSBasePlugin_getKeyValuePairById (FbcSBasePlugin_t *fsbp, const char *sid)
 _tGet_t _ta_t _tKeyValuePair_t_t _tfrom_t _tthe_t _tFbcSBasePlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
ListOf_tFbcSBasePlugin_getListOfKeyValuePairs (FbcSBasePlugin_t *fsbp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tKeyValuePair_t_t _tobjects_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t.
 
unsigned int FbcSBasePlugin_getNumKeyValuePairs (FbcSBasePlugin_t *fsbp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tKeyValuePair_t_t _tobjects_t _tin_t _tthis_t _tFbcSBasePlugin_t_t.
 
KeyValuePair_tFbcSBasePlugin_removeKeyValuePair (FbcSBasePlugin_t *fsbp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tKeyValuePair_t_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
KeyValuePair_tFbcSBasePlugin_removeKeyValuePairById (FbcSBasePlugin_t *fsbp, const char *sid)
 _tRemoves_t _tthe_t _tKeyValuePair_t_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Implementation of the FbcSBasePlugin_t class.

Author
SBMLTeam

Function Documentation

◆ FbcSBasePlugin_addKeyValuePair()

int FbcSBasePlugin_addKeyValuePair ( FbcSBasePlugin_t fsbp,
const KeyValuePair_t kvp 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKeyValuePair_t_t _tto_t _tthis_t _tFbcSBasePlugin_t_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tKeyValuePair_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tkvp_t _tthe_t _tKeyValuePair_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 _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_createKeyValuePair()

KeyValuePair_t * FbcSBasePlugin_createKeyValuePair ( FbcSBasePlugin_t fsbp)

_tCreates_t _ta_t _tnew_t _tKeyValuePair_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tFbcSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tKeyValuePair_t_t _tobject_t _tcreated_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tKeyValuePair_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tKeyValuePair_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_getKeyValuePair()

KeyValuePair_t * FbcSBasePlugin_getKeyValuePair ( FbcSBasePlugin_t fsbp,
unsigned int  n 
)

_tGet_t _ta_t _tKeyValuePair_t_t _tfrom_t _tthe_t _tFbcSBasePlugin_t_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_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 _tKeyValuePair_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tKeyValuePair_t_t _tin_t _tthe_t _tListOfKeyValuePairs_t _twithin_t _tthis_t _tFbcSBasePlugin_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 _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_getKeyValuePairById()

KeyValuePair_t * FbcSBasePlugin_getKeyValuePairById ( FbcSBasePlugin_t fsbp,
const char *  sid 
)

_tGet_t _ta_t _tKeyValuePair_t_t _tfrom_t _tthe_t _tFbcSBasePlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_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 _tKeyValuePair_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tKeyValuePair_t_t _tin_t _tthe_t _tListOfKeyValuePairs_t _twithin_t _tthis_t _tFbcSBasePlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tKeyValuePair_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_getListOfKeyValuePairs()

ListOf_t * FbcSBasePlugin_getListOfKeyValuePairs ( FbcSBasePlugin_t fsbp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tKeyValuePair_t_t _tobjects_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_t_t _tstructure_t _twhose_t _tListOfKeyValuePairs_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfKeyValuePairs_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tFbcSBasePlugin_addKeyValuePair_t() @_tsee_t _tFbcSBasePlugin_createKeyValuePair_t() @_tsee_t _tFbcSBasePlugin_getKeyValuePairById_t() @_tsee_t _tFbcSBasePlugin_getKeyValuePair_t() @_tsee_t _tFbcSBasePlugin_getNumKeyValuePairs_t() @_tsee_t _tFbcSBasePlugin_removeKeyValuePairById_t() @_tsee_t _tFbcSBasePlugin_removeKeyValuePair_t()

@_tmemberof_t _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_getNumKeyValuePairs()

unsigned int FbcSBasePlugin_getNumKeyValuePairs ( FbcSBasePlugin_t fsbp)

_tGet_t _tthe_t _tnumber_t _tof_t _tKeyValuePair_t_t _tobjects_t _tin_t _tthis_t _tFbcSBasePlugin_t_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tKeyValuePair_t_t _tobjects_t _tin_t _tthis_t _tFbcSBasePlugin_t_t.

@_tmemberof_t _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_removeKeyValuePair()

KeyValuePair_t * FbcSBasePlugin_removeKeyValuePair ( FbcSBasePlugin_t fsbp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tKeyValuePair_t_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_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 _tKeyValuePair_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tKeyValuePair_t_t _tin_t _tthis_t _tFbcSBasePlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcSBasePlugin_t_t

◆ FbcSBasePlugin_removeKeyValuePairById()

KeyValuePair_t * FbcSBasePlugin_removeKeyValuePairById ( FbcSBasePlugin_t fsbp,
const char *  sid 
)

_tRemoves_t _tthe_t _tKeyValuePair_t_t _tfrom_t _tthis_t _tFbcSBasePlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tfsbp_t _tthe_t _tFbcSBasePlugin_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 _tKeyValuePair_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tKeyValuePair_t_t _tin_t _tthis_t _tFbcSBasePlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tKeyValuePair_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tFbcSBasePlugin_t_t