libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
GroupsExtension.cpp File Reference

Implementation of GroupsExtension_t. More...

Include dependency graph for GroupsExtension.cpp:

Functions

GroupKind_t GroupKind_fromString (const char *code)
 _tReturns_t _tthe_t _tenumeration_t _tvalue_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t _tor_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.
 
int GroupKind_isValid (GroupKind_t gk)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tenumeration_t _tvalue_t _tis_t _tvalid_t.
 
int GroupKind_isValidString (const char *code)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t _tenumeration_t _tvalue_t.
 
const char * GroupKind_toString (GroupKind_t gk)
 _tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t _tenumeration_t _tvalue_t.
 

Variables

static const char * SBML_GROUP_KIND_STRINGS []
 

Detailed Description

Implementation of GroupsExtension_t.

Author
SBMLTeam

Function Documentation

◆ GroupKind_fromString()

GroupKind_t GroupKind_fromString ( const char *  code)

_tReturns_t _tthe_t _tenumeration_t _tvalue_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t _tor_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.

@_tparam_t _tcode_t _tthe_t _tstring_t _tto_t _tconvert_t _tto_t _tan_t _tenumeration_t _tvalue_t.

@_treturn_t _tthe_t _tcorresponding_t _tvalue_t, _tor_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t} _tif_t _tno_t _tmatch_t _tis_t _tfound_t.

@_tnote_t _tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tclassification_t" _twill_t _treturn_t @_tsbmlconstant_t{_tGROUP_KIND_CLASSIFICATION_t, _tGroupKind_t_t}, _tbut_t "_tClassification_t" _twill_t _treturn_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t}.

@_tif_t _tconly_t @_tmemberof_t _tGroup_t_t @_tendif_t

◆ GroupKind_isValid()

int GroupKind_isValid ( GroupKind_t  gk)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tenumeration_t _tvalue_t _tis_t _tvalid_t.

@_tparam_t _tgk_t _tthe_t _tenumeration_t _tvalue_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tGROUP_KIND_CLASSIFICATION_t, _tGroupKind_t_t}, @_tsbmlconstant_t{_tGROUP_KIND_PARTONOMY_t, _tGroupKind_t_t}, _tor_t @_tsbmlconstant_t{_tGROUP_KIND_COLLECTION_t, _tGroupKind_t_t}; @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t}).

@_tif_t _tconly_t @_tmemberof_t _tGroup_t_t @_tendif_t

◆ GroupKind_isValidString()

int GroupKind_isValidString ( const char *  code)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tstring_t _tis_t _ta_t _tvalid_t _tenumeration_t _tvalue_t.

@_tparam_t _tcode_t _tthe_t _tstring_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tis_t "_tclassification_t", "_tpartonomy_t", _tor_t "_tcollection_t"; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tclassification_t" _twill_t _treturn_t @_tc_t _t1_t (_ttrue_t), _tbut_t "_tClassification_t" _twill_t _treturn_t @_tc_t _t0_t (_tfalse_t).

@_tif_t _tconly_t @_tmemberof_t _tGroup_t_t @_tendif_t

◆ GroupKind_toString()

const char * GroupKind_toString ( GroupKind_t  gk)

_tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t _tenumeration_t _tvalue_t.

@_tparam_t _tgk_t _tthe_t _tenumeration_t _tvalue_t _tto_t _tconvert_t.

@_treturn_t _tA_t _tstring_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _ttype_t: "_tclassification_t", "_tpartonomy_t", "_tcollection_t", _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tGROUP_KIND_UNKNOWN_t, _tGroupKind_t_t} _tor_t _tanother_t _tinvalid_t _tenumeration_t _tvalue_t.

@_tcopydetails_t _tdoc_returned_unowned_char_t

@_tif_t _tconly_t @_tmemberof_t _tGroup_t_t @_tendif_t

Variable Documentation

◆ SBML_GROUP_KIND_STRINGS

const char* SBML_GROUP_KIND_STRINGS[]
static
Initial value:
=
{
"classification"
, "partonomy"
, "collection"
, "(Unknown SBML Groups Type)"
}