libSBML C API
libSBML 5.20.4 C API
|
Definition of CompSBasePlugin_t, the plugin class of comp package for the Model_t element. More...
Functions | |
int | CompSBasePlugin_addReplacedElement (CompSBasePlugin_t *csbp, const ReplacedElement_t *re) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _tthis_t _tCompSBasePlugin_t_t. | |
ReplacedBy_t * | CompSBasePlugin_createReplacedBy (CompSBasePlugin_t *csbp) |
_tCreates_t _ta_t _tnew_t _tReplacedBy_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tReplacedBy_t_t _tobject_t _tcreated_t. | |
ReplacedElement_t * | CompSBasePlugin_createReplacedElement (CompSBasePlugin_t *csbp) |
_tCreates_t _ta_t _tnew_t _tReplacedElement_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tReplacedElement_t_t _tobject_t _tcreated_t. | |
ListOf_t * | CompSBasePlugin_getListOfReplacedElements (CompSBasePlugin_t *csbp) |
_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tReplacedElement_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBasePlugin_t_t. | |
unsigned int | CompSBasePlugin_getNumReplacedElements (CompSBasePlugin_t *csbp) |
_tGet_t _tthe_t _tnumber_t _tof_t _tReplacedElement_t_t _tobjects_t _tin_t _tthis_t _tCompSBasePlugin_t_t. | |
const ReplacedBy_t * | CompSBasePlugin_getReplacedBy (const CompSBasePlugin_t *csbp) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t. | |
ReplacedElement_t * | CompSBasePlugin_getReplacedElement (CompSBasePlugin_t *csbp, unsigned int n) |
_tGet_t _ta_t _tReplacedElement_t_t _tfrom_t _tthe_t _tCompSBasePlugin_t_t. | |
int | CompSBasePlugin_isSetReplacedBy (const CompSBasePlugin_t *csbp) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tCompSBasePlugin_t_t'_ts_t "_treplacedBy_t" _telement_t _tis_t _tset_t. | |
ReplacedElement_t * | CompSBasePlugin_removeReplacedElement (CompSBasePlugin_t *csbp, unsigned int n) |
_tRemoves_t _tthe_t _tnth_t _tReplacedElement_t_t _tfrom_t _tthis_t _tCompSBasePlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
int | CompSBasePlugin_setReplacedBy (CompSBasePlugin_t *csbp, const ReplacedBy_t *replacedBy) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t. | |
int | CompSBasePlugin_unsetReplacedBy (CompSBasePlugin_t *csbp) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t. | |
Definition of CompSBasePlugin_t, the plugin class of comp package for the Model_t element.
int CompSBasePlugin_addReplacedElement | ( | CompSBasePlugin_t * | csbp, |
const ReplacedElement_t * | re | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tReplacedElement_t_t _tshould_t _tbe_t _tadded_t.
@_tparam_t _tre_t _tthe_t _tReplacedElement_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 _tCompSBasePlugin_t_t
ReplacedBy_t * CompSBasePlugin_createReplacedBy | ( | CompSBasePlugin_t * | csbp | ) |
_tCreates_t _ta_t _tnew_t _tReplacedBy_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tReplacedBy_t_t _tobject_t _tcreated_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tReplacedBy_t_t _tshould_t _tbe_t _tadded_t.
@_treturn_t _ta_t _tnew_t _tReplacedBy_t_t _tobject_t _tinstance_t.
@_tmemberof_t _tCompSBasePlugin_t_t
ReplacedElement_t * CompSBasePlugin_createReplacedElement | ( | CompSBasePlugin_t * | csbp | ) |
_tCreates_t _ta_t _tnew_t _tReplacedElement_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompSBasePlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tReplacedElement_t_t _tobject_t _tcreated_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tReplacedElement_t_t _tshould_t _tbe_t _tadded_t.
@_treturn_t _ta_t _tnew_t _tReplacedElement_t_t _tobject_t _tinstance_t.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tmemberof_t _tCompSBasePlugin_t_t
ListOf_t * CompSBasePlugin_getListOfReplacedElements | ( | CompSBasePlugin_t * | csbp | ) |
_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tReplacedElement_t_t _tobjects_t _tfrom_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _twhose_t _tListOfReplacedElements_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tListOfReplacedElements_t _tfrom_t _tthis_t _tCompSBasePlugin_t_t _tas_t _ta_t _tListOf_t_t *.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tsee_t _tCompSBasePlugin_addReplacedElement_t() @_tsee_t _tCompSBasePlugin_createReplacedElement_t() @_tsee_t _tCompSBasePlugin_getReplacedElementById_t() @_tsee_t _tCompSBasePlugin_getReplacedElement_t() @_tsee_t _tCompSBasePlugin_getNumReplacedElements_t() @_tsee_t _tCompSBasePlugin_removeReplacedElementById_t() @_tsee_t _tCompSBasePlugin_removeReplacedElement_t()
@_tmemberof_t _tCompSBasePlugin_t_t
unsigned int CompSBasePlugin_getNumReplacedElements | ( | CompSBasePlugin_t * | csbp | ) |
_tGet_t _tthe_t _tnumber_t _tof_t _tReplacedElement_t_t _tobjects_t _tin_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tReplacedElement_t_t _tobjects_t _tin_t _tthis_t _tCompSBasePlugin_t_t.
@_tmemberof_t _tCompSBasePlugin_t_t
const ReplacedBy_t * CompSBasePlugin_getReplacedBy | ( | const CompSBasePlugin_t * | csbp | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t _twhose_t _treplacedBy_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t _tas_t _ta_t _tReplacedBy_t.
@_tmemberof_t _tCompSBasePlugin_t_t
ReplacedElement_t * CompSBasePlugin_getReplacedElement | ( | CompSBasePlugin_t * | csbp, |
unsigned int | n | ||
) |
_tGet_t _ta_t _tReplacedElement_t_t _tfrom_t _tthe_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_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 _tReplacedElement_t_t _tto_t _tretrieve_t.
@_treturn_t _tthe_t _tnth_t _tReplacedElement_t_t _tin_t _tthe_t _tListOfReplacedElements_t _twithin_t _tthis_t _tCompSBasePlugin_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 _tCompSBasePlugin_t_t
int CompSBasePlugin_isSetReplacedBy | ( | const CompSBasePlugin_t * | csbp | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tCompSBasePlugin_t_t'_ts_t "_treplacedBy_t" _telement_t _tis_t _tset_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tCompSBasePlugin_t_t'_ts_t "_treplacedBy_t" _telement_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.
@_tmemberof_t _tCompSBasePlugin_t_t
ReplacedElement_t * CompSBasePlugin_removeReplacedElement | ( | CompSBasePlugin_t * | csbp, |
unsigned int | n | ||
) |
_tRemoves_t _tthe_t _tnth_t _tReplacedElement_t_t _tfrom_t _tthis_t _tCompSBasePlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_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 _tReplacedElement_t_t _tto_t _tremove_t.
@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tReplacedElement_t_t _tin_t _tthis_t _tCompSBasePlugin_t_t.
@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t
@_tmemberof_t _tCompSBasePlugin_t_t
int CompSBasePlugin_setReplacedBy | ( | CompSBasePlugin_t * | csbp, |
const ReplacedBy_t * | replacedBy | ||
) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_t_t _tstructure_t.
@_tparam_t _treplacedBy_t _tReplacedBy_t_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_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}
@_tmemberof_t _tCompSBasePlugin_t_t
int CompSBasePlugin_unsetReplacedBy | ( | CompSBasePlugin_t * | csbp | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_treplacedBy_t" _telement_t _tof_t _tthis_t _tCompSBasePlugin_t_t.
@_tparam_t _tcsbp_t _tthe_t _tCompSBasePlugin_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 _tCompSBasePlugin_t_t