libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
FunctionTerm.h File Reference

Implementation of the FunctionTerm_t class. More...

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

Functions

FunctionTerm_tFunctionTerm_clone (FunctionTerm_t *ft)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.
 
FunctionTerm_tFunctionTerm_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tFunctionTerm_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.
 
void FunctionTerm_free (FunctionTerm_t *ft)
 _tFrees_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.
 
const ASTNode_tFunctionTerm_getMath (const FunctionTerm_t *ft)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.
 
int FunctionTerm_getResultLevel (FunctionTerm_t *ft)
 _tTakes_t _ta_t _tFunctionTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t _tresultLevel_t.
 
int FunctionTerm_hasRequiredAttributes (const FunctionTerm_t *ft)
 _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 _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int FunctionTerm_hasRequiredElements (const FunctionTerm_t *ft)
 _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 _telements_t _tfor_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int FunctionTerm_isSetMath (const FunctionTerm_t *ft)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFunctionTerm_t_t'_ts_t "_tmath_t" _telement_t _tis_t _tset_t.
 
int FunctionTerm_isSetResultLevel (FunctionTerm_t *ft)
 _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 _tFunctionTerm_t_t _tstructure_t'_ts_t _tresultLevel_t _tis_t _tset_t.
 
int FunctionTerm_setMath (FunctionTerm_t *ft, const ASTNode_t *math)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.
 
int FunctionTerm_setResultLevel (FunctionTerm_t *ft, int resultLevel)
 _tSets_t _tthe_t "_tresultLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.
 
int FunctionTerm_unsetMath (FunctionTerm_t *ft)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.
 
int FunctionTerm_unsetResultLevel (FunctionTerm_t *ft)
 _tUnsets_t _tthe_t "_tresultLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.
 
FunctionTerm_tListOfFunctionTerms_getById (ListOf_t *lo, const char *sid)
 _tReturn_t _tthe_t _tFunctionTerm_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
FunctionTerm_tListOfFunctionTerms_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tFunctionTerm_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Implementation of the FunctionTerm_t class.

Author
Generated by autocreate code

Function Documentation

◆ FunctionTerm_clone()

FunctionTerm_t * FunctionTerm_clone ( FunctionTerm_t ft)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tFunctionTerm_t_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_create()

FunctionTerm_t * FunctionTerm_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tFunctionTerm_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_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 _tFunctionTerm_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 _tFunctionTerm_t_t. @_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t '_tQual_t' _tpackage_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tFunctionTerm_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tFunctionTerm_t_t _tstructure_t.

@_tmemberof_t _tFunctionTerm_t_t

_tCreates_t _ta_t _tnew_t _tFunctionTerm_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.

◆ FunctionTerm_free()

void FunctionTerm_free ( FunctionTerm_t ft)

_tFrees_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_getMath()

const ASTNode_t * FunctionTerm_getMath ( const FunctionTerm_t ft)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t _twhose_t _tmath_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t _tas_t _ta_t _tASTNode_t_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_getResultLevel()

int FunctionTerm_getResultLevel ( FunctionTerm_t ft)

_tTakes_t _ta_t _tFunctionTerm_t_t _tstructure_t _tand_t _treturns_t _tits_t _tresultLevel_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _twhose_t _tresultLevel_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tresultLevel_t _tattribute_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t, _tas_t _tan_t @_tc_t _tint_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_hasRequiredAttributes()

int FunctionTerm_hasRequiredAttributes ( const FunctionTerm_t ft)

_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 _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_hasRequiredElements()

int FunctionTerm_hasRequiredElements ( const FunctionTerm_t ft)

_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 _telements_t _tfor_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _telements_t _tfor_t _ta_t _tFunctionTerm_t _tobject_t _tare_t: @_tli_t "_tmath_t"

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_isSetMath()

int FunctionTerm_isSetMath ( const FunctionTerm_t ft)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFunctionTerm_t_t'_ts_t "_tmath_t" _telement_t _tis_t _tset_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tFunctionTerm_t_t'_ts_t "_tmath_t" _telement_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_isSetResultLevel()

int FunctionTerm_isSetResultLevel ( FunctionTerm_t ft)

_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 _tFunctionTerm_t_t _tstructure_t'_ts_t _tresultLevel_t _tis_t _tset_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_setMath()

int FunctionTerm_setMath ( FunctionTerm_t ft,
const ASTNode_t math 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tmath_t _tASTNode_t_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_setResultLevel()

int FunctionTerm_setResultLevel ( FunctionTerm_t ft,
int  resultLevel 
)

_tSets_t _tthe_t "_tresultLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tresultLevel_t _tthe_t _tvalue_t _tof_t _tresultLevel_t _tto_t _tassign_t _tto_t _tthe_t "_tresultLevel_t" _tattribute_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 _tFunctionTerm_t_t

◆ FunctionTerm_unsetMath()

int FunctionTerm_unsetMath ( FunctionTerm_t ft)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _telement_t _tof_t _tthis_t _tFunctionTerm_t_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFunctionTerm_t_t

◆ FunctionTerm_unsetResultLevel()

int FunctionTerm_unsetResultLevel ( FunctionTerm_t ft)

_tUnsets_t _tthe_t "_tresultLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tFunctionTerm_t_t _tstructure_t.

@_tparam_t _tft_t _tthe_t _tFunctionTerm_t_t _tstructure_t _tto_t _tunset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tFunctionTerm_t_t

◆ ListOfFunctionTerms_getById()

FunctionTerm_t * ListOfFunctionTerms_getById ( ListOf_t lo,
const char *  sid 
)

_tReturn_t _tthe_t _tFunctionTerm_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _ta_t _tstring_t, _tthe_t _tidentifier_t _tof_t _tthe_t _tFunctionTerm_t_t _tbeing_t _tsought_t.

@_treturn_t _tthe_t _tFunctionTerm_t_t _tfor_t _tthe_t _tgiven_t _tvariable_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tFunctionTerm_t_t _texists_t.

@_tmemberof_t _tFunctionTerm_t_t

◆ ListOfFunctionTerms_removeById()

FunctionTerm_t * ListOfFunctionTerms_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tFunctionTerm_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tFunctionTerm_t_t _tsought_t.

@_treturn_t _tthe_t _tFunctionTerm_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _tFunctionTerm_t_t _tstructure_t _twith_t _tthe_t "_tid_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

@_tmemberof_t _tListOfFunctionTerms_t_t