libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
Submodel.cpp File Reference

Implementation of Submodel_t, the SBase_t-derived class of the comp package. More...

Include dependency graph for Submodel.cpp:

Functions

int Submodel_addDeletion (Submodel_t *s, Deletion_t *d)
 _tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tDeletion_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
Submodel_tSubmodel_clone (Submodel_t *s)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
Submodel_tSubmodel_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 @_tcond_t _tdoxygenIgnored_t
 
Deletion_tSubmodel_createDeletion (Submodel_t *s)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tDeletion_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t, _tand_t _treturns_t _tthe_t _tDeletion_t_t.
 
void Submodel_free (Submodel_t *s)
 _tFrees_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
Deletion_tSubmodel_getDeletion (Submodel_t *s, unsigned int n)
 _tReturn_t _ta_t _tspecific_t _tDeletion_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t.
 
Deletion_tSubmodel_getDeletionById (Submodel_t *s, const char *sid)
 _tReturn_t _tthe_t _tDeletion_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
char * Submodel_getExtentConversionFactor (Submodel_t *s)
 _tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _textentConversionFactor_t.
 
char * Submodel_getId (Submodel_t *s)
 _tTakes_t _tan_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
ListOf_tSubmodel_getListOfDeletions (Submodel_t *s)
 _tGet_t _tthe_t _tlist_t _tof_t _tDeletion_t_t _tstructures_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
char * Submodel_getModelRef (Submodel_t *s)
 _tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tmodelRef_t.
 
char * Submodel_getName (Submodel_t *s)
 _tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
unsigned int Submodel_getNumDeletions (Submodel_t *s)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t.
 
char * Submodel_getSubstanceConversionFactor (Submodel_t *)
 _tReturns_t _tNULL_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.
 
char * Submodel_getTimeConversionFactor (Submodel_t *s)
 _tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttimeConversionFactor_t.
 
int Submodel_hasRequiredAttributes (Submodel_t *s)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Submodel_hasRequiredElements (Submodel_t *s)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Submodel_isSetExtentConversionFactor (Submodel_t *s)
 _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 _tSubmodel_t_t _tstructure_t'_ts_t _textentConversionFactor_t _tis_t _tset_t.
 
int Submodel_isSetId (Submodel_t *s)
 _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 _tSubmodel_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int Submodel_isSetModelRef (Submodel_t *s)
 _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 _tSubmodel_t_t _tstructure_t'_ts_t _tmodelRef_t _tis_t _tset_t.
 
int Submodel_isSetName (Submodel_t *s)
 _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 _tSubmodel_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int Submodel_isSetSubstanceConversionFactor (Submodel_t *)
 _tReturns_t @_tc_t _tfalse_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.
 
int Submodel_isSetTimeConversionFactor (Submodel_t *s)
 _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 _tSubmodel_t_t _tstructure_t'_ts_t _ttimeConversionFactor_t _tis_t _tset_t.
 
Deletion_tSubmodel_removeDeletion (Submodel_t *s, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tDeletion_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Deletion_tSubmodel_removeDeletionById (Submodel_t *s, const char *sid)
 _tRemoves_t _tthe_t _tDeletion_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int Submodel_setExtentConversionFactor (Submodel_t *s, const char *extentConversionFactor)
 _tSets_t _tthe_t _textentConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _textentConversionFactor_t.
 
int Submodel_setId (Submodel_t *s, const char *id)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tSubmodel_t_t _tstructure_t.
 
int Submodel_setModelRef (Submodel_t *s, const char *modelRef)
 _tSets_t _tthe_t _tmodelRef_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tmodelRef_t.
 
int Submodel_setName (Submodel_t *s, const char *name)
 _tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.
 
int Submodel_setSubstanceConversionFactor (Submodel_t *, const char *)
 _tAutomatically_t _tfails_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.
 
int Submodel_setTimeConversionFactor (Submodel_t *s, const char *timeConversionFactor)
 _tSets_t _tthe_t _ttimeConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _ttimeConversionFactor_t.
 
int Submodel_unsetExtentConversionFactor (Submodel_t *s)
 _tUnsets_t _tthe_t "_textentConversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
int Submodel_unsetId (Submodel_t *s)
 _tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
int Submodel_unsetModelRef (Submodel_t *s)
 _tUnsets_t _tthe_t "_tmodelRef_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
int Submodel_unsetName (Submodel_t *s)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 
int Submodel_unsetSubstanceConversionFactor (Submodel_t *)
 _tAutomatically_t _tfails_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.
 
int Submodel_unsetTimeConversionFactor (Submodel_t *s)
 _tUnsets_t _tthe_t "_ttimeConversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.
 

Detailed Description

Implementation of Submodel_t, the SBase_t-derived class of the comp package.

Author
Lucian Smith

Function Documentation

◆ Submodel_addDeletion()

int Submodel_addDeletion ( Submodel_t s,
Deletion_t d 
)

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tDeletion_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tDeletion_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _td_t _ta_t _tDeletion_t_t _tstructure_t _tto_t _tadd_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_clone()

Submodel_t * Submodel_clone ( Submodel_t s)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tSubmodel_t_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_create()

Submodel_t * Submodel_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

@_tcond_t _tdoxygenIgnored_t

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

◆ Submodel_createDeletion()

Deletion_t * Submodel_createDeletion ( Submodel_t s)

_tCreates_t _ta_t _tnew_t, _tempty_t _tDeletion_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t, _tand_t _treturns_t _tthe_t _tDeletion_t_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tDeletion_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _tthe_t _tnewly_t-_tcreated_t _tempty_t _tDeletion_t_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_free()

void Submodel_free ( Submodel_t s)

_tFrees_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getDeletion()

Deletion_t * Submodel_getDeletion ( Submodel_t s,
unsigned int  n 
)

_tReturn_t _ta_t _tspecific_t _tDeletion_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tn_t _tan_t _tinteger_t, _tthe_t _tindex_t _tof_t _tthe_t _tDeletion_t_t _tstructure_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tnth_t _tDeletion_t_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tDeletion_t_t _texists_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getDeletionById()

Deletion_t * Submodel_getDeletionById ( Submodel_t s,
const char *  sid 
)

_tReturn_t _tthe_t _tDeletion_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tuse_t.

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

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getExtentConversionFactor()

char * Submodel_getExtentConversionFactor ( Submodel_t s)

_tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _textentConversionFactor_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _twhose_t _textentConversionFactor_t _tis_t _tsought_t.

@_treturn_t _tthe_t _textentConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getId()

char * Submodel_getId ( Submodel_t s)

_tTakes_t _tan_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tidentifier_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getListOfDeletions()

ListOf_t * Submodel_getListOfDeletions ( Submodel_t s)

_tGet_t _tthe_t _tlist_t _tof_t _tDeletion_t_t _tstructures_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tDeletion_t_t _tstructures_t _tfor_t _tthe_t _tgiven_t _tSubmodel_t_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getModelRef()

char * Submodel_getModelRef ( Submodel_t s)

_tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tmodelRef_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _twhose_t _tmodelRef_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tmodelRef_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getName()

char * Submodel_getName ( Submodel_t s)

_tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getNumDeletions()

unsigned int Submodel_getNumDeletions ( Submodel_t s)

_tReturns_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tSubmodel_t_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getSubstanceConversionFactor()

char * Submodel_getSubstanceConversionFactor ( Submodel_t s)

_tReturns_t _tNULL_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _twhose_t _tsubstanceConversionFactor_t _tis_t _tsought_t.

@_treturn_t _tNULL_t

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_getTimeConversionFactor()

char * Submodel_getTimeConversionFactor ( Submodel_t s)

_tTakes_t _ta_t _tSubmodel_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttimeConversionFactor_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _twhose_t _ttimeConversionFactor_t _tis_t _tsought_t.

@_treturn_t _tthe_t _ttimeConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_hasRequiredAttributes()

int Submodel_hasRequiredAttributes ( Submodel_t s)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tSubmodel_t_t _tstructure_t _tare_t: @_tli_t _tid_t @_tli_t _tmodelRef_t

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_hasRequiredElements()

int Submodel_hasRequiredElements ( Submodel_t s)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tA_t _tSubmodel_t_t _tstructure_t _thas_t _tno_t _trequired_t _tchild_t _telements_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetExtentConversionFactor()

int Submodel_isSetExtentConversionFactor ( Submodel_t s)

_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 _tSubmodel_t_t _tstructure_t'_ts_t _textentConversionFactor_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetId()

int Submodel_isSetId ( Submodel_t s)

_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 _tSubmodel_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetModelRef()

int Submodel_isSetModelRef ( Submodel_t s)

_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 _tSubmodel_t_t _tstructure_t'_ts_t _tmodelRef_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetName()

int Submodel_isSetName ( Submodel_t s)

_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 _tSubmodel_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetSubstanceConversionFactor()

int Submodel_isSetSubstanceConversionFactor ( Submodel_t s)

_tReturns_t @_tc_t _tfalse_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t0_t (_tfalse_t)

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_isSetTimeConversionFactor()

int Submodel_isSetTimeConversionFactor ( Submodel_t s)

_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 _tSubmodel_t_t _tstructure_t'_ts_t _ttimeConversionFactor_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_removeDeletion()

Deletion_t * Submodel_removeDeletion ( Submodel_t s,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tDeletion_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_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 _ts_t _tthe_t _tSubmodel_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tDeletion_t_t _tsought_t.

@_treturn_t _tthe_t _tDeletion_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _titem_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tgiven_t _tindex_t _tis_t _tout_t _tof_t _trange_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_removeDeletionById()

Deletion_t * Submodel_removeDeletionById ( Submodel_t s,
const char *  sid 
)

_tRemoves_t _tthe_t _tDeletion_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tSubmodel_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 _ts_t _tthe_t _tSubmodel_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tDeletion_t_t _tsought_t.

@_treturn_t _tthe_t _tDeletion_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 _tDeletion_t_t _tstructure_t _twith_t _tthe_t "_tid_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_setExtentConversionFactor()

int Submodel_setExtentConversionFactor ( Submodel_t s,
const char *  extentConversionFactor 
)

_tSets_t _tthe_t _textentConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _textentConversionFactor_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _textentConversionFactor_t _tthe_t _textentConversionFactor_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t'_ts_t "_textentConversionFactor_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 "_textentConversionFactor_t" _tattribute_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_setId()

int Submodel_setId ( Submodel_t s,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tSubmodel_t_t _tstructure_t.

_tThis_t _tmakes_t _ta_t _tcopy_t _tof_t _tthe_t _tstring_t _tpassed_t _tin_t _tthe_t _tparameter_t @_tp_t _tsid_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tidentifier_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 _tan_t @_tp_t _tsid_t _tof_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tSubmodel_t_t

Examples
spec_example1.c.

◆ Submodel_setModelRef()

int Submodel_setModelRef ( Submodel_t s,
const char *  modelRef 
)

_tSets_t _tthe_t _tmodelRef_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tmodelRef_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tmodelRef_t _tthe_t _tmodelRef_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t'_ts_t "_tmodelRef_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 "_tmodelRef_t" _tattribute_t.

@_tmemberof_t _tSubmodel_t_t

Examples
spec_example1.c.

◆ Submodel_setName()

int Submodel_setName ( Submodel_t s,
const char *  name 
)

_tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tname_t _tthe_t _tname_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t'_ts_t "_tname_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 "_tname_t" _tattribute_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_setSubstanceConversionFactor()

int Submodel_setSubstanceConversionFactor ( Submodel_t s,
const char *  substanceConversionFactor 
)

_tAutomatically_t _tfails_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsubstanceConversionFactor_t _tthe_t _tsubstanceConversionFactor_t _tto_t _tignore_t.

@_tcopydetails_t _tdoc_returns_one_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_setTimeConversionFactor()

int Submodel_setTimeConversionFactor ( Submodel_t s,
const char *  timeConversionFactor 
)

_tSets_t _tthe_t _ttimeConversionFactor_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _ttimeConversionFactor_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttimeConversionFactor_t _tthe_t _ttimeConversionFactor_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tSubmodel_t_t'_ts_t "_ttimeConversionFactor_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 "_ttimeConversionFactor_t" _tattribute_t.

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_unsetExtentConversionFactor()

int Submodel_unsetExtentConversionFactor ( Submodel_t s)

_tUnsets_t _tthe_t "_textentConversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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 _tSubmodel_t_t

◆ Submodel_unsetId()

int Submodel_unsetId ( Submodel_t s)

_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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 _tSubmodel_t_t

◆ Submodel_unsetModelRef()

int Submodel_unsetModelRef ( Submodel_t s)

_tUnsets_t _tthe_t "_tmodelRef_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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 _tSubmodel_t_t

◆ Submodel_unsetName()

int Submodel_unsetName ( Submodel_t s)

_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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 _tSubmodel_t_t

◆ Submodel_unsetSubstanceConversionFactor()

int Submodel_unsetSubstanceConversionFactor ( Submodel_t s)

_tAutomatically_t _tfails_t, _tsince_t "_tsubstanceConversionFactor_t" _tis_t _tnot_t _ta_t _tpart_t _tof_t _tthe_t _tcomp_t _tspec_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_t_t _tstructure_t _tto_t _tunset_t.

@_tcopydetails_t _tdoc_returns_one_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSubmodel_t_t

◆ Submodel_unsetTimeConversionFactor()

int Submodel_unsetTimeConversionFactor ( Submodel_t s)

_tUnsets_t _tthe_t "_ttimeConversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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 _tSubmodel_t_t