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

Definition of ConversionProperties_t, the class encapsulating conversion configuration. More...

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

Functions

void ConversionProperties_addOption (ConversionProperties_t *cp, const ConversionOption_t *option)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConversionOption_t_t _tstructure_t _tto_t _tthe_t _tproperties_t.
 
void ConversionProperties_addOptionWithKey (ConversionProperties_t *cp, const char *key)
 _tAdds_t _ta_t _tnew_t _tConversionOption_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tthe_t _tproperties_t.
 
ConversionProperties_tConversionProperties_clone (const ConversionProperties_t *cp)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConversionProperties_t_t _tstructure_t.
 
ConversionProperties_tConversionProperties_create ()
 _tCreates_t _ta_t _tnew_t _tconversion_t _tproperties_t _tstructure_t (_twithout_t _tnamespace_t)
 
ConversionProperties_tConversionProperties_createWithSBMLNamespace (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tconversion_t _tproperties_t _tstructure_t _twith_t _ta_t _tspecific_t _tSBML_t _ttarget_t _tnamespace_t.
 
void ConversionProperties_free (ConversionProperties_t *cp)
 _tDestroys_t _tthis_t _tconversion_t _tproperties_t _tstructure_t
 
int ConversionProperties_getBoolValue (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tvalue_t _tas_t _tboolean_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
char * ConversionProperties_getDescription (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tdescription_t _tstring_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
double ConversionProperties_getDoubleValue (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tvalue_t _tas_t _tdouble_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
float ConversionProperties_getFloatValue (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tvalue_t _tas_t _tfloat_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
int ConversionProperties_getIntValue (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tvalue_t _tas_t _tinteger_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
const ConversionOption_tConversionProperties_getOption (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tConversionOption_t_t _tstructure_t _tfor_t _ta_t _tgiven_t _tkey_t.
 
const SBMLNamespaces_tConversionProperties_getTargetNamespaces (const ConversionProperties_t *cp)
 _tReturns_t _tthe_t _tcurrent_t _ttarget_t _tSBML_t _tnamespace_t _tof_t _tthe_t _tconversion_t _tproperties_t.
 
ConversionOptionType_t ConversionProperties_getType (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _ttype_t _tof_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
char * ConversionProperties_getValue (const ConversionProperties_t *cp, const char *key)
 _tReturns_t _tthe_t _tvalue_t _tstring_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.
 
int ConversionProperties_hasOption (const ConversionProperties_t *cp, const char *key)
 _tChecks_t _twhether_t _tthe_t _tgiven_t _tproperties_t _tstructure_t _thas_t _tan_t _toption_t _tfor_t _tthe_t _tgiven_t _tkey_t
 
int ConversionProperties_hasTargetNamespaces (const ConversionProperties_t *cp)
 _tTests_t _twhether_t _tthe_t _tgiven_t _tconversion_t _tproperties_t _thas_t _ta_t _ttarget_t _tnamespace_t _tset_t
 
ConversionOption_tConversionProperties_removeOption (ConversionProperties_t *cp, const char *key)
 _tRemoves_t _tthe_t _tConversionOption_t_t _twith_t _tthe_t _tgiven_t _tkey_t _tfrom_t _tthe_t _tproperties_t.
 
void ConversionProperties_setBoolValue (ConversionProperties_t *cp, const char *key, int value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tboolean_t _tvalue_t.
 
void ConversionProperties_setDoubleValue (ConversionProperties_t *cp, const char *key, double value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tdouble_t _tvalue_t.
 
void ConversionProperties_setFloatValue (ConversionProperties_t *cp, const char *key, float value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tfloat_t _tvalue_t.
 
void ConversionProperties_setIntValue (ConversionProperties_t *cp, const char *key, int value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tint_t _tvalue_t.
 
void ConversionProperties_setTargetNamespaces (ConversionProperties_t *cp, SBMLNamespaces_t *sbmlns)
 _tSets_t _tthe_t _ttarget_t _tnamespace_t.
 
void ConversionProperties_setValue (ConversionProperties_t *cp, const char *key, const char *value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tvalue_t.
 

Detailed Description

Definition of ConversionProperties_t, the class encapsulating conversion configuration.

Author
Frank Bergmann

Function Documentation

◆ ConversionProperties_addOption()

void ConversionProperties_addOption ( ConversionProperties_t cp,
const ConversionOption_t option 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConversionOption_t_t _tstructure_t _tto_t _tthe_t _tproperties_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _toption_t _tthe_t _toption_t _tto_t _tadd_t.

@_tmemberof_t _tConversionProperties_t_t

Examples
flattenModel.c, promoteParameters.c, and stripPackage.c.

◆ ConversionProperties_addOptionWithKey()

void ConversionProperties_addOptionWithKey ( ConversionProperties_t cp,
const char *  key 
)

_tAdds_t _ta_t _tnew_t _tConversionOption_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tthe_t _tproperties_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _tnew_t _toption_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_clone()

ConversionProperties_t * ConversionProperties_clone ( const ConversionProperties_t cp)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tConversionProperties_t_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t _tto_t _tclone_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tConversionProperties_t_t _tstructure_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_create()

ConversionProperties_t * ConversionProperties_create ( )

_tCreates_t _ta_t _tnew_t _tconversion_t _tproperties_t _tstructure_t (_twithout_t _tnamespace_t)

@_tmemberof_t _tConversionProperties_t_t

Examples
flattenModel.c, promoteParameters.c, and stripPackage.c.

◆ ConversionProperties_createWithSBMLNamespace()

ConversionProperties_t * ConversionProperties_createWithSBMLNamespace ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tconversion_t _tproperties_t _tstructure_t _twith_t _ta_t _tspecific_t _tSBML_t _ttarget_t _tnamespace_t.

@_tparam_t _tsbmlns_t _tthe_t _ttarget_t _tnamespace_t _tto_t _tconvert_t _tto_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_free()

void ConversionProperties_free ( ConversionProperties_t cp)

_tDestroys_t _tthis_t _tconversion_t _tproperties_t _tstructure_t

@_tmemberof_t _tConversionProperties_t_t

Examples
promoteParameters.c.

◆ ConversionProperties_getBoolValue()

int ConversionProperties_getBoolValue ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tvalue_t _tas_t _tboolean_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tboolean_t _tvalue_t _tof_t _tthe_t _toption_t _tas_t _tan_t _tinteger_t (@_tc_t _t1_t = _ttrue_t; @_tc_t _t0_t = _tfalse_t _tor_t @_tc_t _tNULL_t) _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getDescription()

char * ConversionProperties_getDescription ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tdescription_t _tstring_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tdescription_t _ttext_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getDoubleValue()

double ConversionProperties_getDoubleValue ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tvalue_t _tas_t _tdouble_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tdouble_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t, _tor_t _tNaN_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getFloatValue()

float ConversionProperties_getFloatValue ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tvalue_t _tas_t _tfloat_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tfloat_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t, _tor_t _tNaN_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getIntValue()

int ConversionProperties_getIntValue ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tvalue_t _tas_t _tinteger_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tinteger_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t, _tor_t -_t1_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getOption()

const ConversionOption_t * ConversionProperties_getOption ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tConversionOption_t_t _tstructure_t _tfor_t _ta_t _tgiven_t _tkey_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t, _tor_t @_tc_t _tNULL_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getTargetNamespaces()

const SBMLNamespaces_t * ConversionProperties_getTargetNamespaces ( const ConversionProperties_t cp)

_tReturns_t _tthe_t _tcurrent_t _ttarget_t _tSBML_t _tnamespace_t _tof_t _tthe_t _tconversion_t _tproperties_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t.

@_treturn_t _tthe_t _tSBMLNamepaces_t_t _tstructure_t _texpressing_t _tthe_t _ttarget_t _tnamespace_t, _tor_t @_tc_t _tNULL_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getType()

ConversionOptionType_t ConversionProperties_getType ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _ttype_t _tof_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _ttype_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_getValue()

char * ConversionProperties_getValue ( const ConversionProperties_t cp,
const char *  key 
)

_tReturns_t _tthe_t _tvalue_t _tstring_t _tfor_t _ta_t _tgiven_t _toption_t _tin_t _tthe_t _tproperties_t _tstructure_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t _tthe_t _tstring_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t, _tor_t @_tc_t _tNULL_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_hasOption()

int ConversionProperties_hasOption ( const ConversionProperties_t cp,
const char *  key 
)

_tChecks_t _twhether_t _tthe_t _tgiven_t _tproperties_t _tstructure_t _thas_t _tan_t _toption_t _tfor_t _tthe_t _tgiven_t _tkey_t

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _toption_t _texists_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_hasTargetNamespaces()

int ConversionProperties_hasTargetNamespaces ( const ConversionProperties_t cp)

_tTests_t _twhether_t _tthe_t _tgiven_t _tconversion_t _tproperties_t _thas_t _ta_t _ttarget_t _tnamespace_t _tset_t

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _ttarget_t _tnamespace_t _thas_t _tbeen_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_removeOption()

ConversionOption_t * ConversionProperties_removeOption ( ConversionProperties_t cp,
const char *  key 
)

_tRemoves_t _tthe_t _tConversionOption_t_t _twith_t _tthe_t _tgiven_t _tkey_t _tfrom_t _tthe_t _tproperties_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tremoved_t _tconversion_t _toption_t (_tneeds_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t), _tor_t @_tc_t _tNULL_t, _tif_t _tno_t _toption_t _twith_t _tthe_t _tgiven_t _tkey_t _texists_t

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setBoolValue()

void ConversionProperties_setBoolValue ( ConversionProperties_t cp,
const char *  key,
int  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tboolean_t _tvalue_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. @_tparam_t _tvalue_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t _toption_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setDoubleValue()

void ConversionProperties_setDoubleValue ( ConversionProperties_t cp,
const char *  key,
double  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tdouble_t _tvalue_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. @_tparam_t _tvalue_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t _toption_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setFloatValue()

void ConversionProperties_setFloatValue ( ConversionProperties_t cp,
const char *  key,
float  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tfloat_t _tvalue_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. @_tparam_t _tvalue_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t _toption_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setIntValue()

void ConversionProperties_setIntValue ( ConversionProperties_t cp,
const char *  key,
int  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tint_t _tvalue_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. @_tparam_t _tvalue_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t _toption_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setTargetNamespaces()

void ConversionProperties_setTargetNamespaces ( ConversionProperties_t cp,
SBMLNamespaces_t sbmlns 
)

_tSets_t _tthe_t _ttarget_t _tnamespace_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tsbmlns_t _tthe_t _ttarget_t _tnamespace_t _tto_t _tuse_t.

@_tmemberof_t _tConversionProperties_t_t

◆ ConversionProperties_setValue()

void ConversionProperties_setValue ( ConversionProperties_t cp,
const char *  key,
const char *  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t _toption_t _twith_t _tgiven_t _tkey_t _tto_t _tthe_t _tgiven_t _tvalue_t.

@_tparam_t _tcp_t _tthe_t _tconversion_t _tproperties_t. @_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. @_tparam_t _tvalue_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t _toption_t.

@_tmemberof_t _tConversionProperties_t_t