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

Definition of the GroupsModelPlugin_t class. More...

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

Functions

int GroupsModelPlugin_addGroup (GroupsModelPlugin_t *gmp, const Group_t *g)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGroup_t_t _tto_t _tthis_t _tGroupsModelPlugin_t_t.
 
Group_tGroupsModelPlugin_createGroup (GroupsModelPlugin_t *gmp)
 _tCreates_t _ta_t _tnew_t _tGroup_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tGroupsModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tGroup_t_t _tobject_t _tcreated_t.
 
Group_tGroupsModelPlugin_getGroup (GroupsModelPlugin_t *gmp, unsigned int n)
 _tGet_t _ta_t _tGroup_t_t _tfrom_t _tthe_t _tGroupsModelPlugin_t_t.
 
Group_tGroupsModelPlugin_getGroupById (GroupsModelPlugin_t *gmp, const char *sid)
 _tGet_t _ta_t _tGroup_t_t _tfrom_t _tthe_t _tGroupsModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
ListOf_tGroupsModelPlugin_getListOfGroups (GroupsModelPlugin_t *gmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tGroup_t_t _tobjects_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t.
 
unsigned int GroupsModelPlugin_getNumGroups (GroupsModelPlugin_t *gmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tGroup_t_t _tobjects_t _tin_t _tthis_t _tGroupsModelPlugin_t_t.
 
Group_tGroupsModelPlugin_removeGroup (GroupsModelPlugin_t *gmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tGroup_t_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Group_tGroupsModelPlugin_removeGroupById (GroupsModelPlugin_t *gmp, const char *sid)
 _tRemoves_t _tthe_t _tGroup_t_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Definition of the GroupsModelPlugin_t class.

Author
SBMLTeam

Function Documentation

◆ GroupsModelPlugin_addGroup()

int GroupsModelPlugin_addGroup ( GroupsModelPlugin_t gmp,
const Group_t g 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tGroup_t_t _tto_t _tthis_t _tGroupsModelPlugin_t_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tGroup_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tg_t _tthe_t _tGroup_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 _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_createGroup()

Group_t * GroupsModelPlugin_createGroup ( GroupsModelPlugin_t gmp)

_tCreates_t _ta_t _tnew_t _tGroup_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tGroupsModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tGroup_t_t _tobject_t _tcreated_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tGroup_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tGroup_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_getGroup()

Group_t * GroupsModelPlugin_getGroup ( GroupsModelPlugin_t gmp,
unsigned int  n 
)

_tGet_t _ta_t _tGroup_t_t _tfrom_t _tthe_t _tGroupsModelPlugin_t_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_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 _tGroup_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tGroup_t_t _tin_t _tthe_t _tListOfGroups_t _twithin_t _tthis_t _tGroupsModelPlugin_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 _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_getGroupById()

Group_t * GroupsModelPlugin_getGroupById ( GroupsModelPlugin_t gmp,
const char *  sid 
)

_tGet_t _ta_t _tGroup_t_t _tfrom_t _tthe_t _tGroupsModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_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 _tGroup_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tGroup_t_t _tin_t _tthe_t _tListOfGroups_t _twithin_t _tthis_t _tGroupsModelPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tGroup_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_getListOfGroups()

ListOf_t * GroupsModelPlugin_getListOfGroups ( GroupsModelPlugin_t gmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tGroup_t_t _tobjects_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_t_t _tstructure_t _twhose_t _tListOfGroups_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfGroups_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tGroupsModelPlugin_addGroup_t() @_tsee_t _tGroupsModelPlugin_createGroup_t() @_tsee_t _tGroupsModelPlugin_getGroupById_t() @_tsee_t _tGroupsModelPlugin_getGroup_t() @_tsee_t _tGroupsModelPlugin_getNumGroups_t() @_tsee_t _tGroupsModelPlugin_removeGroupById_t() @_tsee_t _tGroupsModelPlugin_removeGroup_t()

@_tmemberof_t _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_getNumGroups()

unsigned int GroupsModelPlugin_getNumGroups ( GroupsModelPlugin_t gmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tGroup_t_t _tobjects_t _tin_t _tthis_t _tGroupsModelPlugin_t_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tGroup_t_t _tobjects_t _tin_t _tthis_t _tGroupsModelPlugin_t_t.

@_tmemberof_t _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_removeGroup()

Group_t * GroupsModelPlugin_removeGroup ( GroupsModelPlugin_t gmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tGroup_t_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_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 _tGroup_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tGroup_t_t _tin_t _tthis_t _tGroupsModelPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroupsModelPlugin_t_t

◆ GroupsModelPlugin_removeGroupById()

Group_t * GroupsModelPlugin_removeGroupById ( GroupsModelPlugin_t gmp,
const char *  sid 
)

_tRemoves_t _tthe_t _tGroup_t_t _tfrom_t _tthis_t _tGroupsModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tgmp_t _tthe_t _tGroupsModelPlugin_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 _tGroup_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tGroup_t_t _tin_t _tthis_t _tGroupsModelPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tGroup_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroupsModelPlugin_t_t