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

Definitions of Unit_t and ListOfUnits_t. More...

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

Functions

int Unit_areEquivalent (Unit_t *unit1, Unit_t *unit2)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tif_t _tUnit_t_t _tstructures_t _tare_t _tequivalent_t.
 
int Unit_areIdentical (Unit_t *unit1, Unit_t *unit2)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _ttwo_t _tUnit_t_t _tstructures_t _tare_t _tidentical_t.
 
Unit_tUnit_clone (const Unit_t *u)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t
 
UnitDefinition_tUnit_convertToSI (Unit_t *unit)
 _tReturns_t _ta_t _tUnitDefinition_t_t _tstructure_t _tcontaining_t _tthe_t _tgiven_t @_tp_t _tunit_t _tconverted_t _tto_t _tthe_t _tappropriate_t _tSI_t _tunit_t.
 
Unit_tUnit_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_warning_unit_offset_only_l2v1_t
 
Unit_tUnit_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tUnit_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void Unit_free (Unit_t *u)
 _tFrees_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t.
 
int Unit_getExponent (const Unit_t *u)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
double Unit_getExponentAsDouble (const Unit_t *u)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
UnitKind_t Unit_getKind (const Unit_t *u)
 _tReturns_t _tthe_t "_tkind_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tunit_t @_tp_t _tu_t.
 
double Unit_getMultiplier (const Unit_t *u)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmultiplier_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
const XMLNamespaces_tUnit_getNamespaces (Unit_t *u)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tUnit_t_t _tstructure_t.
 
double Unit_getOffset (const Unit_t *u)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_toffset_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_getScale (const Unit_t *u)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_hasRequiredAttributes (Unit_t *u)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tUnit_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
void Unit_initDefaults (Unit_t *u)
 _tInitializes_t _tthe_t _tattributes_t _tof_t _tthis_t _tUnit_t_t (_texcept_t _tfor_t "_tkind_t") _tto_t _ttheir_t _tdefault_t _tvalues_t.
 
int Unit_isAmpere (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tampere_t.
 
int Unit_isBecquerel (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tbecquerel_t.
 
int Unit_isBuiltIn (const char *name, unsigned int level)
 _tPredicate_t _tto_t _ttest_t _twhether_t _ta_t _tgiven_t _tstring_t _tis_t _tthe_t _tname_t _tof_t _ta_t _tbuilt_t-_tin_t _tSBML_t _tunit_t, _tdepending_t _ton_t _tthe_t _tSBML_t _tlevel_t, _tsince_t _tnew_t _tpredefined_t _tunits_t _twere_t _tadded_t _tbetween_t _tlevel_t _t2_t _tversions_t _t1_t _tand_t _t2_t, _tand_t _tthen_t _tall_t _tpredefined_t _tunits_t _twere_t _tremoved_t _tagain_t _tin_t _tSBML_t _tLevel_t _t3_t.
 
int Unit_isCandela (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tcandela_t.
 
int Unit_isCelsius (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tCelsius_t.
 
int Unit_isCoulomb (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tcoulomb_t.
 
int Unit_isDimensionless (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tdimensionless_t.
 
int Unit_isFarad (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tfarad_t.
 
int Unit_isGram (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tgram_t.
 
int Unit_isGray (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tgray_t.
 
int Unit_isHenry (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _thenry_t.
 
int Unit_isHertz (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _thertz_t.
 
int Unit_isItem (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _titem_t.
 
int Unit_isJoule (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tjoule_t.
 
int Unit_isKatal (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkatal_t.
 
int Unit_isKelvin (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkelvin_t.
 
int Unit_isKilogram (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkilogram_t.
 
int Unit_isLitre (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlitre_t _tor_t @_tc_t _tliter_t.
 
int Unit_isLumen (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlumen_t.
 
int Unit_isLux (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlux_t.
 
int Unit_isMetre (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tmetre_t _tor_t @_tc_t _tmeter_t.
 
int Unit_isMole (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tmole_t.
 
int Unit_isNewton (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tnewton_t.
 
int Unit_isOhm (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tohm_t.
 
int Unit_isPascal (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tpascal_t.
 
int Unit_isRadian (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tradian_t.
 
int Unit_isSecond (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsecond_t.
 
int Unit_isSetExponent (const Unit_t *u)
 _tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.
 
int Unit_isSetKind (const Unit_t *u)
 _tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.
 
int Unit_isSetMultiplier (const Unit_t *u)
 _tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tmultiplier_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.
 
int Unit_isSetOffset (const Unit_t *u)
 _tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.
 
int Unit_isSetScale (const Unit_t *u)
 _tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.
 
int Unit_isSiemens (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsiemens_t.
 
int Unit_isSievert (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsievert_t.
 
int Unit_isSteradian (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsteradian_t.
 
int Unit_isTesla (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _ttesla_t.
 
int Unit_isVolt (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tvolt_t.
 
int Unit_isWatt (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _twatt_t.
 
int Unit_isWeber (const Unit_t *u)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tweber_t.
 
void Unit_merge (Unit_t *unit1, Unit_t *unit2)
 _tMerges_t _ttwo_t _tUnit_t_t _tstructures_t _twith_t _tthe_t _tsame_t "_tkind_t" _tattribute_t _tvalue_t _tinto_t _ta_t _tsingle_t _tUnit_t.
 
int Unit_removeScale (Unit_t *unit)
 _tManipulates_t _tthe_t _tattributes_t _tof_t _tthe_t _tUnit_t_t _tto_t _texpress_t _tthe_t _tunit_t _twith_t _tthe_t _tvalue_t _tof_t _tthe_t _tscale_t _tattribute_t _treduced_t _tto_t _tzero_t.
 
int Unit_setExponent (Unit_t *u, int value)
 _tSets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_setExponentAsDouble (Unit_t *u, double value)
 _tSets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_setKind (Unit_t *u, UnitKind_t kind)
 _tSets_t _tthe_t _tkind_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tto_t _tthe_t _tgiven_t _tUnitKind_t_t _tvalue_t.
 
int Unit_setMultiplier (Unit_t *u, double value)
 _tSets_t _tthe_t "_tmultiplier_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_setOffset (Unit_t *u, double value)
 _tSets_t _tthe_t "_toffset_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_setScale (Unit_t *u, int value)
 _tSets_t _tthe_t "_tscale_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_unsetExponent (Unit_t *u)
 _tUnsets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_unsetKind (Unit_t *u)
 _tUnsets_t _tthe_t _tkind_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_unsetMultiplier (Unit_t *u)
 _tUnsets_t _tthe_t "_tmultiplier_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_unsetOffset (Unit_t *u)
 _tUnsets_t _tthe_t "_toffset_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 
int Unit_unsetScale (Unit_t *u)
 _tUnsets_t _tthe_t "_tscale_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.
 

Detailed Description

Definitions of Unit_t and ListOfUnits_t.

Author
Ben Bornstein

Function Documentation

◆ Unit_areEquivalent()

int Unit_areEquivalent ( Unit_t unit1,
Unit_t unit2 
)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tif_t _tUnit_t_t _tstructures_t _tare_t _tequivalent_t.

_tTwo_t _tUnit_t_t _tstructures_t _tare_t _tconsidered_t _tto_t _tbe_t @_tem_t _tequivalent_t _teither_t _tif_t (_t1_t) _tboth_t _thave_t _ta_t "_tkind_t" _tattribute_t _tvalue_t _tof_t @_tc_t _tdimensionless_t, _tor_t (_t2_t) _ttheir_t "_tkind_t", "_texponent_t" _tand_t (_tfor_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t) "_toffset_t" _tattribute_t _tvalues_t _tare_t _tequal_t. (_tContrast_t _tthis_t _tto_t _tthe_t _tmethod_t _tUnit_areIdentical_t(), _twhich_t _tcompares_t _tUnit_t_t _tstructures_t _twith_t _trespect_t _tto_t _tall_t _tattributes_t, _tnot_t _tjust_t _tthe_t "_tkind_t" _tand_t "_texponent_t".)

@_tparam_t _tunit1_t _tthe_t _tfirst_t _tUnit_t_t _tstructure_t _tto_t _tcompare_t. @_tparam_t _tunit2_t _tthe_t _tsecond_t _tUnit_t_t _tstructure_t _tto_t _tcompare_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tand_t "_texponent_t" _tattributes_t _tof_t _tunit1_t _tare_t _tidentical_t _tto_t _tthe_t _tkind_t _tand_t _texponent_t _tattributes_t _tof_t _tunit2_t, _tor_t _tif_t _tthe_t _tkind_t _tattributes_t _tof_t _tboth_t _tare_t @_tc_t _tdimensionless_t; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tUnit_areIdentical_t()

@_tmemberof_t _tUnit_t_t

◆ Unit_areIdentical()

int Unit_areIdentical ( Unit_t unit1,
Unit_t unit2 
)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _ttwo_t _tUnit_t_t _tstructures_t _tare_t _tidentical_t.

_tTwo_t _tUnit_t_t _tstructures_t _tare_t _tconsidered_t _tto_t _tbe_t @_tem_t _tidentical_t _tif_t _tthey_t _tmatch_t _tin_t _tall_t _tattributes_t. (_tContrast_t _tthis_t _tto_t _tthe_t _tmethod_t _tUnit_areEquivalent_t(), _twhich_t _tcompares_t _tUnit_t_t _tstructures_t _tonly_t _twith_t _trespect_t _tto_t _tcertain_t _tattributes_t.)

@_tparam_t _tunit1_t _tthe_t _tfirst_t _tUnit_t_t _tstructure_t _tto_t _tcompare_t. @_tparam_t _tunit2_t _tthe_t _tsecond_t _tUnit_t_t _tstructure_t _tto_t _tcompare_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _tattributes_t _tof_t _tunit1_t _tare_t _tidentical_t _tto_t _tthe_t _tattributes_t _tof_t _tunit2_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tUnit_areEquivalent_t()

@_tmemberof_t _tUnit_t_t

◆ Unit_clone()

Unit_t * Unit_clone ( const Unit_t u)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_convertToSI()

UnitDefinition_t * Unit_convertToSI ( Unit_t unit)

_tReturns_t _ta_t _tUnitDefinition_t_t _tstructure_t _tcontaining_t _tthe_t _tgiven_t @_tp_t _tunit_t _tconverted_t _tto_t _tthe_t _tappropriate_t _tSI_t _tunit_t.

_tThis_t _tmethod_t _texists_t _tbecause_t _tsome_t _tunits_t _tcan_t _tbe_t _texpressed_t _tin_t _tterms_t _tof_t _tothers_t _twhen_t _tthe_t _tsame_t _tphysical_t _tdimension_t _tis_t _tinvolved_t. _tFor_t _texample_t, _tone_t _thertz_t _tis_t _tidentical_t _tto_t _t1_t&_tnbsp_t;_tsec_t<_tsup_t>-_t1_t</_tsup_t>, _tone_t _tlitre_t _tis_t _tequivalent_t _tto_t _t1_t _tcubic_t _tdecametre_t, _tand_t _tso_t _ton_t.

@_tparam_t _tunit_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tconvert_t _tto_t _tSI_t.

@_treturn_t _ta_t _tUnitDefinition_t_t _tstructure_t _tcontaining_t _tthe_t _tSI_t _tunit_t.

@_tsee_t _tUnit_merge_t()

@_tmemberof_t _tUnit_t_t

◆ Unit_create()

Unit_t * Unit_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_warning_unit_offset_only_l2v1_t

@_twarning_t <_tspan_t _tclass_t="_twarning_t">_tThe_t "_toffset_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t. _tThis_t _tattribute_t _tis_t _tnot_t _tpresent_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t _tor_t _tabove_t. _tWhen_t _tproducing_t _tSBML_t _tmodels_t _tusing_t _tthese_t _tlater_t _tspecifications_t, _tmodelers_t _tand_t _tsoftware_t _ttools_t _tneed_t _tto_t _taccount_t _tfor_t _tunits_t _twith_t _toffsets_t _texplicitly_t. _tThe_t SBML_t _tspecification_t _tdocument_t _toffers_t _ta_t _tnumber_t _tof_t _tsuggestions_t _tfor_t _thow_t _tto_t _tachieve_t _tthis_t. _tLibSBML_t _tmethods_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t "_toffset_t" _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.</_tspan_t>

_tCreates_t _ta_t _tnew_t _tUnit_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_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 _tUnit_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 _tUnit_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tUnit_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tUnit_t_t

@_tclass_t _tdoc_warning_unit_offset_only_l2v1_t

@_tcond_t _tdoxygenIgnored_t

◆ Unit_createWithNS()

Unit_t * Unit_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tUnit_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tSBMLNamespaces_t, _ta_t _tpointer_t _tto_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tassign_t _tto_t _tthis_t _tUnit_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tUnit_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tUnit_t_t

◆ Unit_free()

void Unit_free ( Unit_t u)

_tFrees_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getExponent()

int Unit_getExponent ( const Unit_t u)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _ta_t _tUnit_t_t _tstructure_t.

@_treturn_t _tthe_t "_texponent_t" _tvalue_t _tof_t _tthis_t _tUnit_t_t _tstructure_t, _tas_t _tan_t _tinteger_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getExponentAsDouble()

double Unit_getExponentAsDouble ( const Unit_t u)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _ta_t _tUnit_t_t _tstructure_t.

@_treturn_t _tthe_t "_texponent_t" _tvalue_t _tof_t _tthis_t _tUnit_t_t _tstructure_t, _tas_t _ta_t _tdouble_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getKind()

UnitKind_t Unit_getKind ( const Unit_t u)

_tReturns_t _tthe_t "_tkind_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tunit_t @_tp_t _tu_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthis_t _tUnit_t_t _tas_t _ta_t _tvalue_t _tfrom_t _tthe_t _tUnitKind_t_t _tenumeration_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getMultiplier()

double Unit_getMultiplier ( const Unit_t u)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmultiplier_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _ta_t _tUnit_t_t _tstructure_t.

@_treturn_t _tthe_t "_tmultiplier_t" _tvalue_t _tof_t _tthis_t _tUnit_t_t, _tas_t _ta_t _tdouble_t

@_tmemberof_t _tUnit_t_t

◆ Unit_getNamespaces()

const XMLNamespaces_t * Unit_getNamespaces ( Unit_t u)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tUnit_t_t _tstructure_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthis_t _tstructure_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getOffset()

double Unit_getOffset ( const Unit_t u)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_toffset_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _ta_t _tUnit_t_t _tstructure_t.

@_treturn_t _tthe_t "_toffset_t" _tvalue_t _tof_t _tthis_t _tUnit_t_t, _tas_t _ta_t _tdouble_t

@_twarning_t _tThe_t "_toffset_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t1_t. _tThis_t _tattribute_t _tis_t _tnot_t _tpresent_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t _tor_t _tabove_t. _tWhen_t _tproducing_t _tSBML_t _tmodels_t _tusing_t _tthese_t _tlater_t _tspecifications_t, _tModelers_t _tand_t _tsoftware_t _tneed_t _tto_t _taccount_t _tfor_t _tunits_t _twith_t _toffsets_t _texplicitly_t. _tThe_t _tSBML_t _tspecification_t _tdocument_t _toffers_t _ta_t _tnumber_t _tof_t _tsuggestions_t _tfor_t _thow_t _tto_t _tachieve_t _tthis_t. _tLibSBML_t _tfunctions_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t "_toffset_t" _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_getScale()

int Unit_getScale ( const Unit_t u)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _ta_t _tUnit_t_t _tstructure_t.

@_treturn_t _tthe_t "_tscale_t" _tvalue_t _tof_t _tthis_t _tUnit_t_t, _tas_t _tan_t _tinteger_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_hasRequiredAttributes()

int Unit_hasRequiredAttributes ( Unit_t u)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tUnit_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tUnit_t_t _tstructure_t _tare_t: @_tli_t _tkind_t @_tli_t _texponent_t (_tL3_t _ton_t) @_tli_t _tmultiplier_t (_tL3_t _ton_t) @_tli_t _tscale_t (_tL3_t _ton_t)

@_treturn_t _ta_t _tboolean_t _tvalue_t _tindicating_t _twhether_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_initDefaults()

void Unit_initDefaults ( Unit_t u)

_tInitializes_t _tthe_t _tattributes_t _tof_t _tthis_t _tUnit_t_t (_texcept_t _tfor_t "_tkind_t") _tto_t _ttheir_t _tdefault_t _tvalues_t.

_tThe_t _tdefault_t _tvalues_t _tare_t _tas_t _tfollows_t:

  • _texponent_t = _t1_t
  • _tscale_t = _t0_t
  • _tmultiplier_t = _t1_t._t0_t

@_tmemberof_t _tUnit_t_t

◆ Unit_isAmpere()

int Unit_isAmpere ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tampere_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tampere_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isBecquerel()

int Unit_isBecquerel ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tbecquerel_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tbecquerel_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isBuiltIn()

int Unit_isBuiltIn ( const char *  name,
unsigned int  level 
)

_tPredicate_t _tto_t _ttest_t _twhether_t _ta_t _tgiven_t _tstring_t _tis_t _tthe_t _tname_t _tof_t _ta_t _tbuilt_t-_tin_t _tSBML_t _tunit_t, _tdepending_t _ton_t _tthe_t _tSBML_t _tlevel_t, _tsince_t _tnew_t _tpredefined_t _tunits_t _twere_t _tadded_t _tbetween_t _tlevel_t _t2_t _tversions_t _t1_t _tand_t _t2_t, _tand_t _tthen_t _tall_t _tpredefined_t _tunits_t _twere_t _tremoved_t _tagain_t _tin_t _tSBML_t _tLevel_t _t3_t.

@_tparam_t _tname_t _ta_t _tstring_t _tto_t _tbe_t _ttested_t _tagainst_t _tthe_t _tbuilt_t-_tin_t _tunit_t _tnames_t. @_tparam_t _tlevel_t _tthe_t _tlevel_t _tof_t _tSBML_t _tone_t _tis_t _tchecking_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t @_tp_t _tname_t _tis_t _tone_t _tof_t @_tc_t "_tsubstance_t", @_tc_t "_tvolume_t", _tor_t @_tc_t "_ttime_t" _tand_t _tthe_t @_tp_t _tlevel_t _tis_t @_tc_t _t1_t; _tor_t _tif_t @_tp_t _tname_t _tis_t _tone_t _tof_t @_tc_t "_tsubstance_t", @_tc_t "_tvolume_t", @_tc_t "_tarea_t", @_tc_t "_tlength_t", _tor_t @_tc_t "_ttime_t" _tand_t _tthe_t @_tp_t _tlevel_t _tis_t @_tc_t _t2_t; @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t _tall_t _tvalues_t _twhen_t @_tp_t _tlevel_t _tis_t @_tc_t _t3_t).

@_tmemberof_t _tUnit_t_t

◆ Unit_isCandela()

int Unit_isCandela ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tcandela_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tcandela_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isCelsius()

int Unit_isCelsius ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tCelsius_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tCelsius_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_twarning_t _tThe_t _tpredefined_t _tunit_t @_tc_t _tCelsius_t _twas_t _tremoved_t _tfrom_t _tthe_t _tlist_t _tof_t _tpredefined_t _tunits_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t _tat_t _tthe_t _tsame_t _ttime_t _tthat_t _tthe_t "_toffset_t" _tattribute_t _twas_t _tremoved_t _tfrom_t _tUnit_t _tdefinitions_t. _tLibSBML_t _tfunctions_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t @_tc_t _tCelsius_t _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isCoulomb()

int Unit_isCoulomb ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tcoulomb_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tcoulomb_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isDimensionless()

int Unit_isDimensionless ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tdimensionless_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tdimensionless_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isFarad()

int Unit_isFarad ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tfarad_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tfarad_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isGram()

int Unit_isGram ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tgram_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tgram_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isGray()

int Unit_isGray ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tgray_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tgray_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isHenry()

int Unit_isHenry ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _thenry_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_thenry_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isHertz()

int Unit_isHertz ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _thertz_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_thertz_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isItem()

int Unit_isItem ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _titem_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_titem_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isJoule()

int Unit_isJoule ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tjoule_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tjoule_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isKatal()

int Unit_isKatal ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkatal_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tkatal_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isKelvin()

int Unit_isKelvin ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkelvin_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tkelvin_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isKilogram()

int Unit_isKilogram ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tkilogram_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tkilogram_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isLitre()

int Unit_isLitre ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlitre_t _tor_t @_tc_t _tliter_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tlitre_t" _tor_t @_tc_t "_tliter_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isLumen()

int Unit_isLumen ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlumen_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tlumen_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isLux()

int Unit_isLux ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tlux_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tlux_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isMetre()

int Unit_isMetre ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tmetre_t _tor_t @_tc_t _tmeter_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tmetre_t" _tor_t @_tc_t "_tmeter_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isMole()

int Unit_isMole ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tmole_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tmole_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isNewton()

int Unit_isNewton ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tnewton_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tnewton_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isOhm()

int Unit_isOhm ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tohm_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tohm_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isPascal()

int Unit_isPascal ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tpascal_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tpascal_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isRadian()

int Unit_isRadian ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tradian_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tradian_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSecond()

int Unit_isSecond ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsecond_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tsecond_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSetExponent()

int Unit_isSetExponent ( const Unit_t u)

_tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_texponent_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSetKind()

int Unit_isSetKind ( const Unit_t u)

_tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSetMultiplier()

int Unit_isSetMultiplier ( const Unit_t u)

_tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tmultiplier_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmultiplier_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSetOffset()

int Unit_isSetOffset ( const Unit_t u)

_tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_twarning_t _tThe_t "_toffset_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t1_t. _tThis_t _tattribute_t _tis_t _tnot_t _tpresent_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t _tor_t _tabove_t. _tWhen_t _tproducing_t _tSBML_t _tmodels_t _tusing_t _tthese_t _tlater_t _tspecifications_t, _tModelers_t _tand_t _tsoftware_t _tneed_t _tto_t _taccount_t _tfor_t _tunits_t _twith_t _toffsets_t _texplicitly_t. _tThe_t _tSBML_t _tspecification_t _tdocument_t _toffers_t _ta_t _tnumber_t _tof_t _tsuggestions_t _tfor_t _thow_t _tto_t _tachieve_t _tthis_t. _tLibSBML_t _tfunctions_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t "_toffset_t" _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSetScale()

int Unit_isSetScale ( const Unit_t u)

_tPredicate_t _tto_t _ttest_t _twhether_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tis_t _tset_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tscale_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSiemens()

int Unit_isSiemens ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsiemens_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tsiemens_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSievert()

int Unit_isSievert ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsievert_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tsievert_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isSteradian()

int Unit_isSteradian ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tsteradian_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tsteradian_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isTesla()

int Unit_isTesla ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _ttesla_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_ttesla_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isVolt()

int Unit_isVolt ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tvolt_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tvolt_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isWatt()

int Unit_isWatt ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _twatt_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_twatt_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_isWeber()

int Unit_isWeber ( const Unit_t u)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _trepresents_t _ta_t _tunit_t _tof_t _tthe_t _tkind_t @_tc_t _tweber_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tkind_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t _tis_t _tset_t _tto_t @_tc_t "_tweber_t", @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_merge()

void Unit_merge ( Unit_t unit1,
Unit_t unit2 
)

_tMerges_t _ttwo_t _tUnit_t_t _tstructures_t _twith_t _tthe_t _tsame_t "_tkind_t" _tattribute_t _tvalue_t _tinto_t _ta_t _tsingle_t _tUnit_t.

_tFor_t _texample_t, _tthe_t _tfollowing_t, @_tverbatim_t <_tunit_t _tkind_t="_tmetre_t" _texponent_t="_t2_t"> <_tunit_t _tkind_t="_tmetre_t" _texponent_t="_t1_t"> @_tendverbatim_t _twould_t _tbe_t _tmerged_t _tto_t _tbecome_t @_tverbatim_t <_tunit_t _tkind_t="_tmetre_t" _texponent_t="_t3_t"> @_tendverbatim_t

@_tparam_t _tunit1_t _tthe_t _tfirst_t _tUnit_t_t _tstructure_t; _tthe_t _tresult_t _tof_t _tthe_t _toperation_t _tis_t _tleft_t _tas_t _ta_t _tnew_t _tversion_t _tof_t _tthis_t _tunit_t, _tmodified_t _tin_t-_tplace_t. _tNot_t _tmodified_t _tif_t _tthe_t _ttwo_t _tunits_t _thave_t _tdifferent_t _tkinds_t.

@_tparam_t _tunit2_t _tthe_t _tsecond_t _tUnit_t_t _tstructure_t _tto_t _tmerge_t _twith_t _tthe_t _tfirst_t.

@_tsee_t _tUnit_convertToSI_t() @_tsee_t _tUnit_removeScale_t()

@_tmemberof_t _tUnit_t_t

◆ Unit_removeScale()

int Unit_removeScale ( Unit_t unit)

_tManipulates_t _tthe_t _tattributes_t _tof_t _tthe_t _tUnit_t_t _tto_t _texpress_t _tthe_t _tunit_t _twith_t _tthe_t _tvalue_t _tof_t _tthe_t _tscale_t _tattribute_t _treduced_t _tto_t _tzero_t.

_tFor_t _texample_t, _t1_t _tmillimetre_t _tcan_t _tbe_t _texpressed_t _tas_t _ta_t _tUnit_t_t _twith_t _tkind_t= @_tc_t "_tmetre_t" _tmultiplier_t=@_tc_t "_t1_t" _tscale_t=@_tc_t "-_t3_t" _texponent_t=@_tc_t "_t1_t". _tIt_t _tcan_t _talso_t _tbe_t _texpressed_t _tas_t _ta_t _tUnit_t_t _twith_t _tkind_t=@_tc_t "_tmetre_t" _tmultiplier_t=<_tcode_t>"_t0_t._t001_t"</_tcode_t> _tscale_t=@_tc_t "_t0_t" _texponent_t=@_tc_t "_t1_t".

@_tparam_t _tunit_t _tthe_t _tUnit_t_t _tstructure_t _tto_t _tmanipulate_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}

@_tsee_t _tUnit_convertToSI_t() @_tsee_t _tUnit_merge_t()

@_tmemberof_t _tUnit_t_t

◆ Unit_setExponent()

int Unit_setExponent ( Unit_t u,
int  value 
)

_tSets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tinteger_t _tto_t _twhich_t _tthe_t _tattribute_t "_texponent_t" _tshould_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_setExponentAsDouble()

int Unit_setExponentAsDouble ( Unit_t u,
double  value 
)

_tSets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tdouble_t _tto_t _twhich_t _tthe_t _tattribute_t "_texponent_t" _tshould_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_setKind()

int Unit_setKind ( Unit_t u,
UnitKind_t  kind 
)

_tSets_t _tthe_t _tkind_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t _tto_t _tthe_t _tgiven_t _tUnitKind_t_t _tvalue_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tkind_t _ta_t _tvalue_t _tfrom_t _tthe_t _tUnitKind_t_t _tenumeration_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_setMultiplier()

int Unit_setMultiplier ( Unit_t u,
double  value 
)

_tSets_t _tthe_t "_tmultiplier_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tinteger_t _tto_t _twhich_t _tthe_t _tattribute_t "_tmultiplier_t" _tshould_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tUnit_t_t

◆ Unit_setOffset()

int Unit_setOffset ( Unit_t u,
double  value 
)

_tSets_t _tthe_t "_toffset_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tinteger_t _tto_t _twhich_t _tthe_t _tattribute_t "_toffset_t" _tshould_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_twarning_t _tThe_t "_toffset_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t1_t. _tThis_t _tattribute_t _tis_t _tnot_t _tpresent_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t _tor_t _tabove_t. _tWhen_t _tproducing_t _tSBML_t _tmodels_t _tusing_t _tthese_t _tlater_t _tspecifications_t, _tModelers_t _tand_t _tsoftware_t _tneed_t _tto_t _taccount_t _tfor_t _tunits_t _twith_t _toffsets_t _texplicitly_t. _tThe_t _tSBML_t _tspecification_t _tdocument_t _toffers_t _ta_t _tnumber_t _tof_t _tsuggestions_t _tfor_t _thow_t _tto_t _tachieve_t _tthis_t. _tLibSBML_t _tfunctions_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t "_toffset_t" _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_setScale()

int Unit_setScale ( Unit_t u,
int  value 
)

_tSets_t _tthe_t "_tscale_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tinteger_t _tto_t _twhich_t _tthe_t _tattribute_t "_tscale_t" _tshould_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_unsetExponent()

int Unit_unsetExponent ( Unit_t u)

_tUnsets_t _tthe_t "_texponent_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_unsetKind()

int Unit_unsetKind ( Unit_t u)

_tUnsets_t _tthe_t _tkind_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_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}

@_tmemberof_t _tUnit_t_t

◆ Unit_unsetMultiplier()

int Unit_unsetMultiplier ( Unit_t u)

_tUnsets_t _tthe_t "_tmultiplier_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tUnit_t_t

◆ Unit_unsetOffset()

int Unit_unsetOffset ( Unit_t u)

_tUnsets_t _tthe_t "_toffset_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_twarning_t _tThe_t "_toffset_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t1_t. _tThis_t _tattribute_t _tis_t _tnot_t _tpresent_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t _tor_t _tabove_t. _tWhen_t _tproducing_t _tSBML_t _tmodels_t _tusing_t _tthese_t _tlater_t _tspecifications_t, _tModelers_t _tand_t _tsoftware_t _tneed_t _tto_t _taccount_t _tfor_t _tunits_t _twith_t _toffsets_t _texplicitly_t. _tThe_t _tSBML_t _tspecification_t _tdocument_t _toffers_t _ta_t _tnumber_t _tof_t _tsuggestions_t _tfor_t _thow_t _tto_t _tachieve_t _tthis_t. _tLibSBML_t _tfunctions_t _tsuch_t _tas_t _tthis_t _tone_t _trelated_t _tto_t "_toffset_t" _tare_t _tretained_t _tfor_t _tcompatibility_t _twith_t _tearlier_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _ttheir_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t.

@_tmemberof_t _tUnit_t_t

◆ Unit_unsetScale()

int Unit_unsetScale ( Unit_t u)

_tUnsets_t _tthe_t "_tscale_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tUnit_t_t _tstructure_t @_tp_t _tu_t.

@_tparam_t _tu_t _tthe_t _tUnit_t_t _tstructure_t _twhose_t _tvalue_t _tis_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}

@_tmemberof_t _tUnit_t_t