libSBML C API
libSBML 5.20.2 C API
|
Definition of ConversionOption_t, the class encapsulating conversion options. More...
Enumerations | |
enum | ConversionOptionType_t { CNV_TYPE_BOOL , CNV_TYPE_DOUBLE , CNV_TYPE_INT , CNV_TYPE_SINGLE , CNV_TYPE_STRING } |
@_tclass_t _tdoc_cnv_type_t More... | |
Functions | |
ConversionOption_t * | ConversionOption_clone (const ConversionOption_t *co) |
_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tConversionOption_t_t _tstructure_t. | |
ConversionOption_t * | ConversionOption_create (const char *key) |
_tCreates_t _ta_t _tnew_t _tConversionOption_t_t _twith_t _tthe_t _tgiven_t _tkey_t. | |
ConversionOption_t * | ConversionOption_createWithKeyAndType (const char *key, ConversionOptionType_t type) |
_tCreates_t _ta_t _tnew_t _tConversionOption_t_t _twith_t _tgiven_t _tkey_t _tand_t _ttype_t. | |
void | ConversionOption_free (ConversionOption_t *co) |
_tDestroys_t _tthis_t _tConversionOption_t_t. | |
int | ConversionOption_getBoolValue (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tboolean_t) _tfor_t _tthe_t _tgiven_t _toption_t. | |
const char * | ConversionOption_getDescription (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tdescription_t _tfor_t _tthe_t _tgiven_t _toption_t. | |
double | ConversionOption_getDoubleValue (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tdouble_t) _tfor_t _tthe_t _tgiven_t _toption_t. | |
float | ConversionOption_getFloatValue (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tfloat_t) _tfor_t _tthe_t _tgiven_t _toption_t. | |
int | ConversionOption_getIntValue (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tinteger_t) _tfor_t _tthe_t _tgiven_t _toption_t. | |
const char * | ConversionOption_getKey (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tkey_t _tfor_t _tthe_t _tgiven_t _toption_t. | |
ConversionOptionType_t | ConversionOption_getType (const ConversionOption_t *co) |
_tReturns_t _tthe_t _ttype_t _tfor_t _tthe_t _tgiven_t _toption_t. | |
const char * | ConversionOption_getValue (const ConversionOption_t *co) |
_tReturns_t _tthe_t _tvalue_t _tfor_t _tthe_t _tgiven_t _toption_t. | |
void | ConversionOption_setBoolValue (ConversionOption_t *co, int value) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setDescription (ConversionOption_t *co, const char *description) |
_tSets_t _tthe_t _tdescription_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setDoubleValue (ConversionOption_t *co, double value) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setFloatValue (ConversionOption_t *co, float value) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setIntValue (ConversionOption_t *co, int value) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setKey (ConversionOption_t *co, const char *key) |
_tSets_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setType (ConversionOption_t *co, ConversionOptionType_t type) |
_tSets_t _tthe_t _ttype_t _tfor_t _tthe_t _toption_t. | |
void | ConversionOption_setValue (ConversionOption_t *co, const char *value) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t. | |
Definition of ConversionOption_t, the class encapsulating conversion options.
@_tclass_t _tdoc_cnv_type_t
@_tpar_t _tThe_t _tconversion_t @_tp_t _ttype_t _targument_t _tvalue_t _tmust_t _tbe_t _tone_t _tof_t @_tif_t _tclike_t _tthe_t _tvalues_t _tdefined_t _tin_t _tthe_t _tenumeration_t #_tConversionOptionType_t_t.@_tendif_t@_tif_t _tjava_t _tthe_t _tconstants_t _twhose_t _tnames_t _tbegin_t _twith_t _tthe_t _tcharacters_t <_tcode_t>_tCNV_TYPE__t</_tcode_t> _tin_t _tthe_t _tinterface_t _tclass_t {@_tlink_t _tlibsbmlConstants_t}.@_tendif_t@_tif_t _tpython_t _tthe_t _tconstants_t _twhose_t _tnames_t _tbegin_t _twith_t _tthe_t _tcharacters_t <_tcode_t>_tCNV_TYPE__t</_tcode_t> _tin_t _tthe_t _tinterface_t _tclass_t @_tlink_t _tlibsbml_t _tlibsbml_t@_tendlink_t.@_tendif_t
@_tenum_t _tConversionOptionType_t_t @_tbrief_t _tConversionOptionType_t_t _tis_t _tthe_t _tenumeration_t _tof_t _tpossible_t _toption_t _ttypes_t.
ConversionOption_t * ConversionOption_clone | ( | const ConversionOption_t * | co | ) |
_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tConversionOption_t_t _tstructure_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t _tto_t _tclone_t.
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tConversionOption_t_t _tstructure_t.
@_tmemberof_t _tConversionOption_t_t
ConversionOption_t * ConversionOption_create | ( | const char * | key | ) |
_tCreates_t _ta_t _tnew_t _tConversionOption_t_t _twith_t _tthe_t _tgiven_t _tkey_t.
@_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthis_t _toption_t.
@_tmemberof_t _tConversionOption_t_t
ConversionOption_t * ConversionOption_createWithKeyAndType | ( | const char * | key, |
ConversionOptionType_t | type | ||
) |
_tCreates_t _ta_t _tnew_t _tConversionOption_t_t _twith_t _tgiven_t _tkey_t _tand_t _ttype_t.
@_tparam_t _tkey_t _tthe_t _tkey_t _tfor_t _tthis_t _toption_t. @_tparam_t _ttype_t _tthe_t _ttype_t _tof_t _tthis_t _toption_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_free | ( | ConversionOption_t * | co | ) |
_tDestroys_t _tthis_t _tConversionOption_t_t.
@_tparam_t _tco_t _tConversionOption_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.
@_tmemberof_t _tConversionOption_t_t
int ConversionOption_getBoolValue | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tboolean_t) _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tvalue_t, @_tc_t _t1_t (_ttrue_t), _tor_t @_tc_t _t0_t (_tfalse_t).
@_tmemberof_t _tConversionOption_t_t
const char * ConversionOption_getDescription | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tdescription_t _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tdescription_t, _tas_t _ta_t _tstring_t.
@_tmemberof_t _tConversionOption_t_t
double ConversionOption_getDoubleValue | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tdouble_t) _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tvalue_t, _tas_t _ta_t _tdouble_t.
@_tmemberof_t _tConversionOption_t_t
float ConversionOption_getFloatValue | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tfloat_t) _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tvalue_t, _tas_t _ta_t _tfloat_t.
@_tmemberof_t _tConversionOption_t_t
int ConversionOption_getIntValue | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tvalue_t (_tas_t _tinteger_t) _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tvalue_t, _tas_t _ta_t _tinteger_t.
@_tmemberof_t _tConversionOption_t_t
const char * ConversionOption_getKey | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tkey_t _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tkey_t, _tas_t _ta_t _tstring_t.
@_tmemberof_t _tConversionOption_t_t
ConversionOptionType_t ConversionOption_getType | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _ttype_t _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _ttype_t
@_tmemberof_t _tConversionOption_t_t
const char * ConversionOption_getValue | ( | const ConversionOption_t * | co | ) |
_tReturns_t _tthe_t _tvalue_t _tfor_t _tthe_t _tgiven_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t.
@_treturn_t _tthe_t _tvalue_t, _tas_t _ta_t _tstring_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setBoolValue | ( | ConversionOption_t * | co, |
int | value | ||
) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tvalue_t _ta_t _tbool_t _trepresenting_t _tthe_t _tvalue_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setDescription | ( | ConversionOption_t * | co, |
const char * | description | ||
) |
_tSets_t _tthe_t _tdescription_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tdescription_t _ta_t _tstring_t _trepresenting_t _tthe_t _tdescription_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setDoubleValue | ( | ConversionOption_t * | co, |
double | value | ||
) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tvalue_t _ta_t _tdouble_t _trepresenting_t _tthe_t _tvalue_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setFloatValue | ( | ConversionOption_t * | co, |
float | value | ||
) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tvalue_t _ta_t _tfloat_t _trepresenting_t _tthe_t _tvalue_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setIntValue | ( | ConversionOption_t * | co, |
int | value | ||
) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tvalue_t _tan_t _tinteger_t _trepresenting_t _tthe_t _tvalue_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setKey | ( | ConversionOption_t * | co, |
const char * | key | ||
) |
_tSets_t _tthe_t _tkey_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tkey_t _ta_t _tstring_t _trepresenting_t _tthe_t _tkey_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setType | ( | ConversionOption_t * | co, |
ConversionOptionType_t | type | ||
) |
_tSets_t _tthe_t _ttype_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _ttype_t _tthe_t _ttype_t _tfor_t _tthis_t _toption_t.
@_tmemberof_t _tConversionOption_t_t
void ConversionOption_setValue | ( | ConversionOption_t * | co, |
const char * | value | ||
) |
_tSets_t _tthe_t _tvalue_t _tfor_t _tthe_t _toption_t.
@_tparam_t _tco_t _tthe_t _tconversion_t _toption_t. @_tparam_t _tvalue_t _ta_t _tstring_t _trepresenting_t _tthe_t _tvalue_t _tto_t _tset_t.
@_tmemberof_t _tConversionOption_t_t