libSBML C API
libSBML 5.20.4 C API
|
: Implementation of the MultiCompartmentPlugin_t class More...
Functions | |
int | MultiCompartmentPlugin_addCompartmentReference (MultiCompartmentPlugin_t *mcp, const CompartmentReference_t *cr) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCompartmentReference_t_t _tto_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
CompartmentReference_t * | MultiCompartmentPlugin_createCompartmentReference (MultiCompartmentPlugin_t *mcp) |
_tCreates_t _ta_t _tnew_t _tCompartmentReference_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tMultiCompartmentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tCompartmentReference_t_t _tobject_t _tcreated_t. | |
CompartmentReference_t * | MultiCompartmentPlugin_getCompartmentReference (MultiCompartmentPlugin_t *mcp, unsigned int n) |
_tGet_t _ta_t _tCompartmentReference_t_t _tfrom_t _tthe_t _tMultiCompartmentPlugin_t_t. | |
CompartmentReference_t * | MultiCompartmentPlugin_getCompartmentReferenceById (MultiCompartmentPlugin_t *mcp, const char *sid) |
_tGet_t _ta_t _tCompartmentReference_t_t _tfrom_t _tthe_t _tMultiCompartmentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t. | |
char * | MultiCompartmentPlugin_getCompartmentType (const MultiCompartmentPlugin_t *mcp) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
int | MultiCompartmentPlugin_getIsType (const MultiCompartmentPlugin_t *mcp) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
ListOf_t * | MultiCompartmentPlugin_getListOfCompartmentReferences (MultiCompartmentPlugin_t *mcp) |
_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tCompartmentReference_t_t _tobjects_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
unsigned int | MultiCompartmentPlugin_getNumCompartmentReferences (MultiCompartmentPlugin_t *mcp) |
_tGet_t _tthe_t _tnumber_t _tof_t _tCompartmentReference_t_t _tobjects_t _tin_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
int | MultiCompartmentPlugin_isSetCompartmentType (const MultiCompartmentPlugin_t *mcp) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tcompartmentType_t" _tattribute_t _tis_t _tset_t. | |
int | MultiCompartmentPlugin_isSetIsType (const MultiCompartmentPlugin_t *mcp) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tisType_t" _tattribute_t _tis_t _tset_t. | |
CompartmentReference_t * | MultiCompartmentPlugin_removeCompartmentReference (MultiCompartmentPlugin_t *mcp, unsigned int n) |
_tRemoves_t _tthe_t _tnth_t _tCompartmentReference_t_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
CompartmentReference_t * | MultiCompartmentPlugin_removeCompartmentReferenceById (MultiCompartmentPlugin_t *mcp, const char *sid) |
_tRemoves_t _tthe_t _tCompartmentReference_t_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
int | MultiCompartmentPlugin_setCompartmentType (MultiCompartmentPlugin_t *mcp, const char *compartmentType) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
int | MultiCompartmentPlugin_setIsType (MultiCompartmentPlugin_t *mcp, int isType) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
int | MultiCompartmentPlugin_unsetCompartmentType (MultiCompartmentPlugin_t *mcp) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
int | MultiCompartmentPlugin_unsetIsType (MultiCompartmentPlugin_t *mcp) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t. | |
: Implementation of the MultiCompartmentPlugin_t class
int MultiCompartmentPlugin_addCompartmentReference | ( | MultiCompartmentPlugin_t * | mcp, |
const CompartmentReference_t * | cr | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCompartmentReference_t_t _tto_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tCompartmentReference_t_t _tshould_t _tbe_t _tadded_t.
@_tparam_t _tcr_t _tthe_t _tCompartmentReference_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 _tMultiCompartmentPlugin_t_t
CompartmentReference_t * MultiCompartmentPlugin_createCompartmentReference | ( | MultiCompartmentPlugin_t * | mcp | ) |
_tCreates_t _ta_t _tnew_t _tCompartmentReference_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tMultiCompartmentPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tCompartmentReference_t_t _tobject_t _tcreated_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tCompartmentReference_t_t _tshould_t _tbe_t _tadded_t.
@_treturn_t _ta_t _tnew_t _tCompartmentReference_t_t _tobject_t _tinstance_t.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
CompartmentReference_t * MultiCompartmentPlugin_getCompartmentReference | ( | MultiCompartmentPlugin_t * | mcp, |
unsigned int | n | ||
) |
_tGet_t _ta_t _tCompartmentReference_t_t _tfrom_t _tthe_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tCompartmentReference_t_t _tto_t _tretrieve_t.
@_treturn_t _tthe_t _tnth_t _tCompartmentReference_t_t _tin_t _tthe_t _tListOfCompartmentReferences_t _twithin_t _tthis_t _tMultiCompartmentPlugin_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
CompartmentReference_t * MultiCompartmentPlugin_getCompartmentReferenceById | ( | MultiCompartmentPlugin_t * | mcp, |
const char * | sid | ||
) |
_tGet_t _ta_t _tCompartmentReference_t_t _tfrom_t _tthe_t _tMultiCompartmentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tCompartmentReference_t_t _tto_t _tretrieve_t.
@_treturn_t _tthe_t _tCompartmentReference_t_t _tin_t _tthe_t _tListOfCompartmentReferences_t _twithin_t _tthis_t _tMultiCompartmentPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tCompartmentReference_t_t _texists_t.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
char * MultiCompartmentPlugin_getCompartmentType | ( | const MultiCompartmentPlugin_t * | mcp | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _twhose_t _tcompartmentType_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.
@_tcopydetails_t _tdoc_warning_returns_owned_char_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_getIsType | ( | const MultiCompartmentPlugin_t * | mcp | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _twhose_t _tisType_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t _tas_t _ta_t _tboolean_t.
@_tmemberof_t _tMultiCompartmentPlugin_t_t
ListOf_t * MultiCompartmentPlugin_getListOfCompartmentReferences | ( | MultiCompartmentPlugin_t * | mcp | ) |
_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tCompartmentReference_t_t _tobjects_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _twhose_t _tListOfCompartmentReferences_t _tis_t _tsought_t.
@_treturn_t _tthe_t _tListOfCompartmentReferences_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t _tas_t _ta_t _tListOf_t_t *.
@_tcopydetails_t _tdoc_returned_unowned_pointer_t
@_tsee_t _tMultiCompartmentPlugin_addCompartmentReference_t() @_tsee_t _tMultiCompartmentPlugin_createCompartmentReference_t() @_tsee_t _tMultiCompartmentPlugin_getCompartmentReferenceById_t() @_tsee_t _tMultiCompartmentPlugin_getCompartmentReference_t() @_tsee_t _tMultiCompartmentPlugin_getNumCompartmentReferences_t() @_tsee_t _tMultiCompartmentPlugin_removeCompartmentReferenceById_t() @_tsee_t _tMultiCompartmentPlugin_removeCompartmentReference_t()
@_tmemberof_t _tMultiCompartmentPlugin_t_t
unsigned int MultiCompartmentPlugin_getNumCompartmentReferences | ( | MultiCompartmentPlugin_t * | mcp | ) |
_tGet_t _tthe_t _tnumber_t _tof_t _tCompartmentReference_t_t _tobjects_t _tin_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tCompartmentReference_t_t _tobjects_t _tin_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_isSetCompartmentType | ( | const MultiCompartmentPlugin_t * | mcp | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tcompartmentType_t" _tattribute_t _tis_t _tset_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tcompartmentType_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_isSetIsType | ( | const MultiCompartmentPlugin_t * | mcp | ) |
_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tisType_t" _tattribute_t _tis_t _tset_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tMultiCompartmentPlugin_t_t'_ts_t "_tisType_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.
@_tmemberof_t _tMultiCompartmentPlugin_t_t
CompartmentReference_t * MultiCompartmentPlugin_removeCompartmentReference | ( | MultiCompartmentPlugin_t * | mcp, |
unsigned int | n | ||
) |
_tRemoves_t _tthe_t _tnth_t _tCompartmentReference_t_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tCompartmentReference_t_t _tto_t _tremove_t.
@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tCompartmentReference_t_t _tin_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
CompartmentReference_t * MultiCompartmentPlugin_removeCompartmentReferenceById | ( | MultiCompartmentPlugin_t * | mcp, |
const char * | sid | ||
) |
_tRemoves_t _tthe_t _tCompartmentReference_t_t _tfrom_t _tthis_t _tMultiCompartmentPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tCompartmentReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _tCompartmentReference_t_t _tin_t _tthis_t _tMultiCompartmentPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tCompartmentReference_t_t _texists_t.
@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_setCompartmentType | ( | MultiCompartmentPlugin_t * | mcp, |
const char * | compartmentType | ||
) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t.
@_tparam_t _tcompartmentType_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tcompartmentType_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}
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_setIsType | ( | MultiCompartmentPlugin_t * | mcp, |
int | isType | ||
) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_t_t _tstructure_t.
@_tparam_t _tisType_t _tint_t _tvalue_t _tof_t _tthe_t "_tisType_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}
@_tmemberof_t _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_unsetCompartmentType | ( | MultiCompartmentPlugin_t * | mcp | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tMultiCompartmentPlugin_t_t
int MultiCompartmentPlugin_unsetIsType | ( | MultiCompartmentPlugin_t * | mcp | ) |
_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tisType_t" _tattribute_t _tof_t _tthis_t _tMultiCompartmentPlugin_t_t.
@_tparam_t _tmcp_t _tthe_t _tMultiCompartmentPlugin_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 _tMultiCompartmentPlugin_t_t