libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
Group.h File Reference

Definition of the Group_t class. More...

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

Functions

int Group_addMember (Group_t *g, const Member_t *m)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tMember_t_t _tto_t _tthis_t _tGroup_t_t.
 
Group_tGroup_clone (const Group_t *g)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tGroup_t_t _tobject_t.
 
Group_tGroup_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 @_tclass_t _tdoc_group_kind_t
 
Member_tGroup_createMember (Group_t *g)
 _tCreates_t _ta_t _tnew_t _tMember_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tGroup_t_t _tobject_t _tand_t _treturns_t _tthe_t _tMember_t_t _tobject_t _tcreated_t.
 
void Group_free (Group_t *g)
 _tFrees_t _tthis_t _tGroup_t_t _tobject_t.
 
char * Group_getId (const Group_t *g)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
GroupKind_t Group_getKind (const Group_t *g)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
char * Group_getKindAsString (const Group_t *g)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
ListOf_tGroup_getListOfMembers (Group_t *g)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tMember_t_t _tobjects_t _tfrom_t _tthis_t _tGroup_t_t.
 
Member_tGroup_getMember (Group_t *g, unsigned int n)
 _tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t.
 
Member_tGroup_getMemberById (Group_t *g, const char *sid)
 _tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
Member_tGroup_getMemberByIdRef (Group_t *g, const char *sid)
 _tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t _tbased_t _ton_t _tthe_t _telement_t _tto_t _twhich_t _tit_t _trefers_t.
 
char * Group_getName (const Group_t *g)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
unsigned int Group_getNumMembers (Group_t *g)
 _tGet_t _tthe_t _tnumber_t _tof_t _tMember_t_t _tobjects_t _tin_t _tthis_t _tGroup_t_t.
 
int Group_hasRequiredAttributes (const Group_t *g)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tGroup_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int Group_isSetId (const Group_t *g)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int Group_isSetKind (const Group_t *g)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tkind_t" _tattribute_t _tis_t _tset_t.
 
int Group_isSetName (const Group_t *g)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
Member_tGroup_removeMember (Group_t *g, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tMember_t_t _tfrom_t _tthis_t _tGroup_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Member_tGroup_removeMemberById (Group_t *g, const char *sid)
 _tRemoves_t _tthe_t _tMember_t_t _tfrom_t _tthis_t _tGroup_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int Group_setId (Group_t *g, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_setKind (Group_t *g, GroupKind_t kind)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_setKindAsString (Group_t *g, const char *kind)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_setName (Group_t *g, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_unsetId (Group_t *g)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_unsetKind (Group_t *g)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 
int Group_unsetName (Group_t *g)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.
 

Detailed Description

Definition of the Group_t class.

Author
SBMLTeam

Function Documentation

◆ Group_addMember()

int Group_addMember ( Group_t g,
const Member_t m 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tMember_t_t _tto_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tMember_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tm_t _tthe_t _tMember_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 _tGroup_t_t

◆ Group_clone()

Group_t * Group_clone ( const Group_t g)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tGroup_t_t _tobject_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tGroup_t_t _tobject_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_create()

Group_t * Group_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

@_tclass_t _tdoc_group_kind_t

@_tpar_t _tThe_t _tattribute_t "_tkind_t" _ton_t _ta_t _tGroup_t _tobject_t _tis_t _tused_t _tto_t _tindicate_t _tthe_t _tnature_t _tof_t _tthe_t _tgroup_t _tdefined_t _tby_t _ta_t _tparticular_t _tGroup_t _tinstance_t. _tIn_t _tthe_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t1_t _tGroup_t _tspecification_t, _tthere_t _tare_t _tonly_t _tthree_t _tallowable_t _tvalues_t _tfor_t "_tkind_t": <_tul_t> <_tli_t> @_tc_t "_tclassification_t", _tto_t _tindicate_t _tthat_t _tthe_t _tgroup_t _trepresents_t _ta_t _tclass_t, _tand_t _tits_t _tmembers_t _thave_t _tan_t <_tem_t>_tis_t-_ta_t</_tem_t> _trelationship_t _tto_t _tthe_t _tgroup_t.

<_tli_t> @_tc_t "_tpartonomy_t", _tto_t _tindicate_t _tthat_t _tthe_t _tgroup_t _trepresents_t _ta_t _tcollection_t _tof_t _tparts_t, _tand_t _tits_t _tmembers_t _thave_t _ta_t <_tem_t>_tpart_t-_tof_t</_tem_t> _trelationship_t _tto_t _tthe_t _tgroup_t.

<_tli_t> @_tc_t "_tcollection_t", _tto_t _tindicate_t _tthat_t _tthe_t _tgrouping_t _tis_t _tmerely_t _ta_t _tcollection_t _tfor_t _tconvenience_t, _twithout_t _tan_t _timplied_t _trelationship_t _tbetween_t _tthe_t _tmembers_t. </_tul_t>

_tCreates_t _ta_t _tnew_t _tGroup_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tgroups_t&_trdquo_t; _tpackage_t _tversion_t.

@_tparam_t _tlevel_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tLevel_t _tto_t _tassign_t _tto_t _tthis_t _tGroup_t_t.

@_tparam_t _tversion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tGroup_t_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tGroups_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tGroup_t_t.

@_tcopydetails_t _tdoc_note_setting_lv_pkg_t

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_createMember()

Member_t * Group_createMember ( Group_t g)

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

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tMember_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tMember_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_free()

void Group_free ( Group_t g)

_tFrees_t _tthis_t _tGroup_t_t _tobject_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_tmemberof_t _tGroup_t_t

◆ Group_getId()

char * Group_getId ( const Group_t g)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _twhose_t _tid_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tGroup_t_t

◆ Group_getKind()

GroupKind_t Group_getKind ( const Group_t g)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _twhose_t _tkind_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t _tas_t _ta_t _tGroupKind_t_t.

@_tcopydetails_t _tdoc_group_kind_t @_tif_t _tclike_t _tThe_t _tvalue_t _tis_t _tdrawn_t _tfrom_t _tthe_t _tenumeration_t @_tref_t _tGroupKind_t_t@_tendif_t

@_tmemberof_t _tGroup_t_t

◆ Group_getKindAsString()

char * Group_getKindAsString ( const Group_t g)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _twhose_t _tkind_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t _tas_t _ta_t _tconst_t _tchar_t *.

@_tcopydetails_t _tdoc_returned_unowned_char_t

@_tcopydetails_t _tdoc_group_kind_t

@_tmemberof_t _tGroup_t_t

◆ Group_getListOfMembers()

ListOf_t * Group_getListOfMembers ( Group_t g)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tMember_t_t _tobjects_t _tfrom_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _twhose_t _tListOfMembers_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfMembers_t _tfrom_t _tthis_t _tGroup_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tGroup_addMember_t() @_tsee_t _tGroup_createMember_t() @_tsee_t _tGroup_getMember_t() @_tsee_t _tGroup_getMemberById_t() @_tsee_t _tGroup_getNumMembers_t() @_tsee_t _tGroup_removeMember_t() @_tsee_t _tGroup_removeMemberById_t()

@_tmemberof_t _tGroup_t_t

◆ Group_getMember()

Member_t * Group_getMember ( Group_t g,
unsigned int  n 
)

_tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_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 _tMember_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tMember_t_t _tin_t _tthe_t _tListOfMembers_t _twithin_t _tthis_t _tGroup_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 _tGroup_t_t

◆ Group_getMemberById()

Member_t * Group_getMemberById ( Group_t g,
const char *  sid 
)

_tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tg_t _tthe_t _tGroup_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 _tMember_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tMember_t_t _tin_t _tthe_t _tListOfMembers_t _twithin_t _tthis_t _tGroup_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tMember_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_getMemberByIdRef()

Member_t * Group_getMemberByIdRef ( Group_t g,
const char *  sid 
)

_tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tGroup_t_t _tbased_t _ton_t _tthe_t _telement_t _tto_t _twhich_t _tit_t _trefers_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t "_tidRef_t" _tattribute_t _tof_t _tthe_t _tMember_t_t _tobject_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tfirst_t _tMember_t_t _tin_t _tthis_t _tGroup_t_t _tbased_t _ton_t _tthe_t _tgiven_t _tidRef_t _tattribute_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tMember_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_getName()

char * Group_getName ( const Group_t g)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tGroup_t_t

◆ Group_getNumMembers()

unsigned int Group_getNumMembers ( Group_t g)

_tGet_t _tthe_t _tnumber_t _tof_t _tMember_t_t _tobjects_t _tin_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tMember_t_t _tobjects_t _tin_t _tthis_t _tGroup_t_t.

@_tmemberof_t _tGroup_t_t

◆ Group_hasRequiredAttributes()

int Group_hasRequiredAttributes ( const Group_t g)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tGroup_t_t _tobject_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tto_t _tindicate_t _tthat_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthis_t _tGroup_t_t _thave_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tGroup_t_t _tobject_t _tare_t: @_tli_t "_tkind_t"

@_tmemberof_t _tGroup_t_t

◆ Group_isSetId()

int Group_isSetId ( const Group_t g)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tid_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tGroup_t_t

◆ Group_isSetKind()

int Group_isSetKind ( const Group_t g)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tkind_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tkind_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tcopydetails_t _tdoc_group_kind_t

@_tmemberof_t _tGroup_t_t

◆ Group_isSetName()

int Group_isSetName ( const Group_t g)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tGroup_t_t'_ts_t "_tname_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tGroup_t_t

◆ Group_removeMember()

Member_t * Group_removeMember ( Group_t g,
unsigned int  n 
)

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

@_tparam_t _tg_t _tthe_t _tGroup_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 _tMember_t_t _tto_t _tremove_t.

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

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_removeMemberById()

Member_t * Group_removeMemberById ( Group_t g,
const char *  sid 
)

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

@_tparam_t _tg_t _tthe_t _tGroup_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 _tMember_t_t _tto_t _tremove_t.

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

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tGroup_t_t

◆ Group_setId()

int Group_setId ( Group_t g,
const char *  id 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_tparam_t _tid_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tid_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}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tid_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tGroup_unsetId_t().

@_tmemberof_t _tGroup_t_t

◆ Group_setKind()

int Group_setKind ( Group_t g,
GroupKind_t  kind 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_tparam_t _tkind_t _tGroupKind_t_t _tvalue_t _tof_t _tthe_t "_tkind_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}

@_tcopydetails_t _tdoc_group_kind_t

@_tmemberof_t _tGroup_t_t

◆ Group_setKindAsString()

int Group_setKindAsString ( Group_t g,
const char *  kind 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_tparam_t _tkind_t _tconst_t _tchar_t * _tof_t _tthe_t "_tkind_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}

@_tcopydetails_t _tdoc_group_kind_t

@_tmemberof_t _tGroup_t_t

◆ Group_setName()

int Group_setName ( Group_t g,
const char *  name 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_t_t _tstructure_t.

@_tparam_t _tname_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tname_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_OBJECT_t, _tOperationReturnValues_t_t}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tname_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tGroup_unsetName_t().

@_tmemberof_t _tGroup_t_t

◆ Group_unsetId()

int Group_unsetId ( Group_t g)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

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

◆ Group_unsetKind()

int Group_unsetKind ( Group_t g)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

@_tparam_t _tg_t _tthe_t _tGroup_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_group_kind_t

@_tmemberof_t _tGroup_t_t

◆ Group_unsetName()

int Group_unsetName ( Group_t g)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tGroup_t_t.

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