libSBML C API  libSBML 5.21.2 C API
Loading...
Searching...
No Matches
UnitKind.c File Reference

SBML UnitKind enumeration. More...

Include dependency graph for UnitKind.c:

Functions

int UnitKind_equals (UnitKind_t uk1, UnitKind_t uk2)
 @_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t
UnitKind_t UnitKind_forName (const char *name)
 @_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t
int UnitKind_isValidUnitKindString (const char *str, unsigned int level, unsigned int version)
 @_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t
const char * UnitKind_toString (UnitKind_t uk)
 @_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

Variables

const char * UNIT_KIND_STRINGS []

Detailed Description

SBML UnitKind enumeration.

Author
Ben Bornstein

Function Documentation

◆ UnitKind_equals()

int UnitKind_equals ( UnitKind_t uk1,
UnitKind_t uk2 )

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

_tTests_t _tfor_t _tlogical_t _tequality_t _tbetween_t _ttwo_t _tgiven_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tcode_t _tvalues_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

_tThis_t _tfunction_t _tbehaves_t _texactly_t _tlike_t _tC_t'_ts_t <_tcode_t>==</_tcode_t> _toperator_t, _texcept_t _tfor_t _tthe_t _tfollowing_t _ttwo_t _tcases_t: <_tul_t> <_tli_t>@_tsbmlconstant_t{_tUNIT_KIND_LITER_t, _tUnitKind_t_t} <_tcode_t>==</_tcode_t> @_tsbmlconstant_t{_tUNIT_KIND_LITRE_t, _tUnitKind_t_t} <_tli_t>@_tsbmlconstant_t{_tUNIT_KIND_METER_t, _tUnitKind_t_t} <_tcode_t>==</_tcode_t> @_tsbmlconstant_t{_tUNIT_KIND_METRE_t, _tUnitKind_t_t} </_tul_t>

_tIn_t _tthe_t _ttwo_t _tcases_t _tabove_t, _tC_t _tequality_t _tcomparison_t _twould_t _tyield_t @_tc_t _t0_t (_tfalse_t) (_tbecause_t _teach_t _tof_t _tthe_t _tabove_t _tis_t _ta_t _tdistinct_t _tenumeration_t _tvalue_t), _tbut_t _tthis_t _tfunction_t _treturns_t @_tc_t _ttrue_t.

@_tparam_t _tuk1_t _ta_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tvalue_t. @_tparam_t _tuk2_t _ta_t _tsecond_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tvalue_t _tto_t _tcompare_t _tto_t @_tp_t _tuk1_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tuk1_t _tis_t _tlogically_t _tequivalent_t _tto_t @_tp_t _tuk2_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tFor_t _tmore_t _tinformation_t _tabout_t _tthe_t _tlibSBML_t _tunit_t _tcodes_t, _tplease_t _trefer_t _tto_t _tthe_t _tclass_t _tdocumentation_t _tfor_t _tUnit_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

◆ UnitKind_forName()

UnitKind_t UnitKind_forName ( const char * name)

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

_tConverts_t _ta_t _ttext_t _tstring_t _tnaming_t _ta_t _tkind_t _tof_t _tunit_t _tto_t _tits_t _tcorresponding_t _tlibSBML_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tconstant_t/_tenumeration_t _tvalue_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

@_tparam_t _tname_t _ta_t _tstring_t, _tthe_t _tname_t _tof_t _ta_t _tpredefined_t _tbase_t _tunit_t _tin_t _tSBML_t.

@_treturn_t @_tif_t _tclike_t _ta_t _tvalue_t _tfrom_t _tUnitKind_t_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t @_tp_t _tname_t (_tdetermined_t _tin_t _ta_t _tcase_t-_tinsensitive_t _tmanner_t). @_tendif_t@_tif_t _tpython_t _ta_t _tvalue_t _tthe_t _tset_t _tof_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tcodes_t _tdefined_t _tin_t _tclass_t @_tlink_t _tlibsbml_t _tlibsbml_t@_tendlink_t, _tcorresponding_t _tto_t _tthe_t _tstring_t @_tp_t _tname_t (_tdetermined_t _tin_t _ta_t _tcase_t-_tinsensitive_t _tmanner_t).@_tendif_t@_tif_t _tjava_t _ta_t _tvalue_t _tthe_t _tset_t _tof_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tcodes_t _tdefined_t _tin_t _tclass_t {@_tlink_t _tlibsbmlConstants_t}, _tcorresponding_t _tto_t _tthe_t _tstring_t @_tp_t _tname_t (_tdetermined_t _tin_t _ta_t _tcase_t-_tinsensitive_t _tmanner_t).@_tendif_t

@_tnote_t _tFor_t _tmore_t _tinformation_t _tabout_t _tthe_t _tlibSBML_t _tunit_t _tcodes_t, _tplease_t _trefer_t _tto_t _tthe_t _tclass_t _tdocumentation_t _tfor_t _tUnit_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

◆ UnitKind_isValidUnitKindString()

int UnitKind_isValidUnitKindString ( const char * str,
unsigned int level,
unsigned int version )

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

_tPredicate_t _tfor_t _ttesting_t _twhether_t _ta_t _tgiven_t _tstring_t _tcorresponds_t _tto_t _ta_t _tpredefined_t _tlibSBML_t _tunit_t _tcode_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

@_tparam_t _tstr_t _ta_t _ttext_t _tstring_t _tnaming_t _ta_t _tbase_t _tunit_t _tdefined_t _tby_t _tSBML_t. @_tparam_t _tlevel_t _tthe_t _tLevel_t _tof_t _tSBML_t. @_tparam_t _tversion_t _tthe_t _tVersion_t _twithin_t _tthe_t _tLevel_t _tof_t _tSBML_t.

@_treturn_t _t1_t (_ttrue_t) _tif_t _tstring_t _tis_t _tthe_t _tname_t _tof_t _ta_t _tvalid_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tvalue_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tFor_t _tmore_t _tinformation_t _tabout_t _tthe_t _tlibSBML_t _tunit_t _tcodes_t, _tplease_t _trefer_t _tto_t _tthe_t _tclass_t _tdocumentation_t _tfor_t _tUnit_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

◆ UnitKind_toString()

const char * UnitKind_toString ( UnitKind_t uk)

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

_tConverts_t _ta_t _tunit_t _tcode_t _tto_t _ta_t _ttext_t _tstring_t _tequivalent_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

@_tparam_t _tuk_t @_tif_t _tclike_t _ta_t _tvalue_t _tfrom_t _tthe_t _tUnitKind_t_t _tenumeration_t @_tendif_t@_tif_t _tpython_t _ta_t _tvalue_t _tfrom_t _tthe_t _tset_t _tof_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tcodes_t _tdefined_t _tin_t _tthe_t _tclass_t @_tlink_t _tlibsbml_t _tlibsbml_t@_tendlink_t @_tendif_t@_tif_t _tjava_t _ta_t _tvalue_t _tfrom_t _tthe_t _tset_t _tof_t <_tcode_t>_tUNIT_KIND__t</_tcode_t> _tcodes_t _tdefined_t _tin_t _tthe_t _tclass_t {@_tlink_t _tlibsbmlConstants_t} @_tendif_t

@_treturn_t _tthe_t _tname_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tunit_t _tcode_t.

@_tnote_t _tFor_t _tmore_t _tinformation_t _tabout_t _tthe_t _tlibSBML_t _tunit_t _tcodes_t, _tplease_t _trefer_t _tto_t _tthe_t _tclass_t _tdocumentation_t _tfor_t _tUnit_t.

@_twarning_t _tThe_t _tstring_t _treturned_t _tis_t _ta_t _tstatic_t _tdata_t _tvalue_t. _tThe_t _tcaller_t _tdoes_t _tnot_t _town_t _tthe_t _treturned_t _tstring_t _tand_t _tis_t _ttherefore_t _tnot_t _tallowed_t _tto_t _tmodify_t _tit_t.

@_tif_t _tconly_t @_tmemberof_t _tUnit_t_t @_tendif_t

Variable Documentation

◆ UNIT_KIND_STRINGS

const char* UNIT_KIND_STRINGS[]