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

Definition of ReplacedElement_t, the SBase_t derived class of replacedElements package. More...

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

Functions

ReplacedElement_tReplacedElement_clone (ReplacedElement_t *re)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.
 
ReplacedElement_tReplacedElement_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tReplacedElement_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 ReplacedElement_free (ReplacedElement_t *re)
 _tFrees_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.
 
char * ReplacedElement_getConversionFactor (ReplacedElement_t *re)
 _tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tconversionFactor_t.
 
char * ReplacedElement_getDeletion (ReplacedElement_t *re)
 _tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tdeletion_t.
 
char * ReplacedElement_getSubmodelRef (ReplacedElement_t *re)
 _tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tsubmodelRef_t.
 
int ReplacedElement_hasRequiredAttributes (ReplacedElement_t *re)
 _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 _tReplacedElement_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int ReplacedElement_isSetConversionFactor (ReplacedElement_t *re)
 _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 _tReplacedElement_t_t _tstructure_t'_ts_t _tconversionFactor_t _tis_t _tset_t.
 
int ReplacedElement_isSetDeletion (ReplacedElement_t *re)
 _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 _tReplacedElement_t_t _tstructure_t'_ts_t _tdeletion_t _tis_t _tset_t.
 
int ReplacedElement_isSetSubmodelRef (ReplacedElement_t *re)
 _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 _tReplacedElement_t_t _tstructure_t'_ts_t _tsubmodelRef_t _tis_t _tset_t.
 
int ReplacedElement_setConversionFactor (ReplacedElement_t *re, const char *conversionFactor)
 _tSets_t _tthe_t _tconversionFactor_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tconversionFactor_t.
 
int ReplacedElement_setDeletion (ReplacedElement_t *re, const char *deletion)
 _tSets_t _tthe_t _tdeletion_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tdeletion_t.
 
int ReplacedElement_setSubmodelRef (ReplacedElement_t *re, const char *submodelRef)
 _tSets_t _tthe_t _tsubmodelRef_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsubmodelRef_t.
 
int ReplacedElement_unsetConversionFactor (ReplacedElement_t *re)
 _tUnsets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.
 
int ReplacedElement_unsetDeletion (ReplacedElement_t *re)
 _tUnsets_t _tthe_t "_tdeletion_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.
 
int ReplacedElement_unsetSubmodelRef (ReplacedElement_t *re)
 _tUnsets_t _tthe_t "_tsubmodelRef_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.
 

Detailed Description

Definition of ReplacedElement_t, the SBase_t derived class of replacedElements package.

Author
Lucian Smith

Function Documentation

◆ ReplacedElement_clone()

ReplacedElement_t * ReplacedElement_clone ( ReplacedElement_t re)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tReplacedElement_t_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_create()

ReplacedElement_t * ReplacedElement_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tReplacedElement_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 _tReplacedElement_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 _tReplacedElement_t_t. @_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t '_tcomp_t' _tpackage_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tReplacedElement_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tReplacedElement_t_t _tstructure_t.

@_tmemberof_t _tReplacedElement_t_t

_tCreates_t _ta_t _tnew_t _tReplacedElement_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.

◆ ReplacedElement_free()

void ReplacedElement_free ( ReplacedElement_t re)

_tFrees_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_getConversionFactor()

char * ReplacedElement_getConversionFactor ( ReplacedElement_t re)

_tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tconversionFactor_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _twhose_t _tconversionFactor_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tconversionFactor_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_getDeletion()

char * ReplacedElement_getDeletion ( ReplacedElement_t re)

_tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tdeletion_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _twhose_t _tdeletion_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tdeletion_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_getSubmodelRef()

char * ReplacedElement_getSubmodelRef ( ReplacedElement_t re)

_tTakes_t _ta_t _tReplacedElement_t_t _tstructure_t _tand_t _treturns_t _tits_t _tsubmodelRef_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _twhose_t _tsubmodelRef_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tsubmodelRef_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_hasRequiredAttributes()

int ReplacedElement_hasRequiredAttributes ( ReplacedElement_t re)

_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 _tReplacedElement_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tReplacedElement_t_t _tstructure_t _tare_t _tthat_t _tit_t _tuses_t _texactly_t _tone_t _tattribute_t _tto_t _trefer_t _tto_t _tits_t _ttarget_t, _tand_t _tthat_t _tthe_t _tsubmodelRef_t _tis_t _tset_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_isSetConversionFactor()

int ReplacedElement_isSetConversionFactor ( ReplacedElement_t re)

_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 _tReplacedElement_t_t _tstructure_t'_ts_t _tconversionFactor_t _tis_t _tset_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_isSetDeletion()

int ReplacedElement_isSetDeletion ( ReplacedElement_t re)

_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 _tReplacedElement_t_t _tstructure_t'_ts_t _tdeletion_t _tis_t _tset_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_isSetSubmodelRef()

int ReplacedElement_isSetSubmodelRef ( ReplacedElement_t re)

_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 _tReplacedElement_t_t _tstructure_t'_ts_t _tsubmodelRef_t _tis_t _tset_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_setConversionFactor()

int ReplacedElement_setConversionFactor ( ReplacedElement_t re,
const char *  conversionFactor 
)

_tSets_t _tthe_t _tconversionFactor_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tconversionFactor_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tconversionFactor_t _tthe_t _tconversionFactor_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tReplacedElement_t_t'_ts_t "_tconversionFactor_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_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tconversionFactor_t" _tattribute_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_setDeletion()

int ReplacedElement_setDeletion ( ReplacedElement_t re,
const char *  deletion 
)

_tSets_t _tthe_t _tdeletion_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tdeletion_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tdeletion_t _tthe_t _tdeletion_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tReplacedElement_t_t'_ts_t "_tdeletion_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_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tdeletion_t" _tattribute_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_setSubmodelRef()

int ReplacedElement_setSubmodelRef ( ReplacedElement_t re,
const char *  submodelRef 
)

_tSets_t _tthe_t _tsubmodelRef_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsubmodelRef_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsubmodelRef_t _tthe_t _tsubmodelRef_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tReplacedElement_t_t'_ts_t "_tsubmodelRef_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_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tsubmodelRef_t" _tattribute_t.

@_tmemberof_t _tReplacedElement_t_t

◆ ReplacedElement_unsetConversionFactor()

int ReplacedElement_unsetConversionFactor ( ReplacedElement_t re)

_tUnsets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_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 _tReplacedElement_t_t

◆ ReplacedElement_unsetDeletion()

int ReplacedElement_unsetDeletion ( ReplacedElement_t re)

_tUnsets_t _tthe_t "_tdeletion_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_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 _tReplacedElement_t_t

◆ ReplacedElement_unsetSubmodelRef()

int ReplacedElement_unsetSubmodelRef ( ReplacedElement_t re)

_tUnsets_t _tthe_t "_tsubmodelRef_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tReplacedElement_t_t _tstructure_t.

@_tparam_t _tre_t _tthe_t _tReplacedElement_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 _tReplacedElement_t_t