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

Implementation of ModifierSpeciesReference_t. More...

Include dependency graph for ModifierSpeciesReference.cpp:

Functions

ModifierSpeciesReference_tModifierSpeciesReference_clone (ModifierSpeciesReference_t *msr)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
ModifierSpeciesReference_tModifierSpeciesReference_create (unsigned int level, unsigned int version)
 @_tendcond_t
 
ModifierSpeciesReference_tModifierSpeciesReference_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.
 
void ModifierSpeciesReference_free (ModifierSpeciesReference_t *msr)
 _tFrees_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
const char * ModifierSpeciesReference_getId (const ModifierSpeciesReference_t *msr)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
const char * ModifierSpeciesReference_getName (const ModifierSpeciesReference_t *msr)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
const char * ModifierSpeciesReference_getSpecies (const ModifierSpeciesReference_t *msr)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_hasRequiredAttributes (const ModifierSpeciesReference_t *msr)
 _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 _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int ModifierSpeciesReference_isSetId (const ModifierSpeciesReference_t *msr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.
 
int ModifierSpeciesReference_isSetName (const ModifierSpeciesReference_t *msr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.
 
int ModifierSpeciesReference_isSetSpecies (const ModifierSpeciesReference_t *msr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tspecies_t" _tis_t _tset_t.
 
int ModifierSpeciesReference_setId (ModifierSpeciesReference_t *msr, const char *id)
 _tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_setName (ModifierSpeciesReference_t *msr, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_setSpecies (ModifierSpeciesReference_t *msr, const char *species)
 _tSets_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_unsetId (ModifierSpeciesReference_t *msr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_unsetName (ModifierSpeciesReference_t *msr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 
int ModifierSpeciesReference_unsetSpecies (ModifierSpeciesReference_t *msr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.
 

Detailed Description

Implementation of ModifierSpeciesReference_t.

Author
Ben Bornstein

Function Documentation

◆ ModifierSpeciesReference_clone()

ModifierSpeciesReference_t * ModifierSpeciesReference_clone ( ModifierSpeciesReference_t msr)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturns_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_create()

ModifierSpeciesReference_t * ModifierSpeciesReference_create ( unsigned int  level,
unsigned int  version 
)

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.

@_tcond_t _tdoxygenLibsbmlInternal_t @_tcond_t _tdoxygenIgnored_t @_tendcond_t

◆ ModifierSpeciesReference_createWithNS()

ModifierSpeciesReference_t * ModifierSpeciesReference_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.

@_tcopydetails_t _tdoc_what_are_sbmlnamespaces_t

@_tparam_t _tsbmlns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tModifierSpeciesReference_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tan_t _terror_t _toccurred_t _tduring_t _tconstruction_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_free()

void ModifierSpeciesReference_free ( ModifierSpeciesReference_t msr)

_tFrees_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_getId()

const char * ModifierSpeciesReference_getId ( const ModifierSpeciesReference_t msr)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_getName()

const char * ModifierSpeciesReference_getName ( const ModifierSpeciesReference_t msr)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_getSpecies()

const char * ModifierSpeciesReference_getSpecies ( const ModifierSpeciesReference_t msr)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_treturn_t _tthe_t _tspecies_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_hasRequiredAttributes()

int ModifierSpeciesReference_hasRequiredAttributes ( const ModifierSpeciesReference_t msr)

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

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_isSetId()

int ModifierSpeciesReference_isSetId ( const ModifierSpeciesReference_t msr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tid_t" _tis_t _tset_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

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

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_isSetName()

int ModifierSpeciesReference_isSetName ( const ModifierSpeciesReference_t msr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tname_t" _tis_t _tset_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

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

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_isSetSpecies()

int ModifierSpeciesReference_isSetSpecies ( const ModifierSpeciesReference_t msr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t'_ts_t "_tspecies_t" _tis_t _tset_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tspecies_t" _tof_t _tthis_t _tModifierSpeciesReference_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_setId()

int ModifierSpeciesReference_setId ( ModifierSpeciesReference_t msr,
const char *  id 
)

_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tid_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tModifierSpeciesReference_unsetId_t().

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tid_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tid_t" _tattribute_t _tshould_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_setName()

int ModifierSpeciesReference_setName ( ModifierSpeciesReference_t msr,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tname_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tModifierSpeciesReference_unsetName_t().

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tname_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tname_t" _tattribute_t _tshould_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tname_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_setSpecies()

int ModifierSpeciesReference_setSpecies ( ModifierSpeciesReference_t msr,
const char *  species 
)

_tSets_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tspecies_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tModifierSpeciesReference_unsetSpecies_t().

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tspecies_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tspecies_t" _tattribute_t _tshould_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tspecies_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t.

@_tmemberof_t _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_unsetId()

int ModifierSpeciesReference_unsetId ( ModifierSpeciesReference_t msr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_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 _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_unsetName()

int ModifierSpeciesReference_unsetName ( ModifierSpeciesReference_t msr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_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 _tModifierSpeciesReference_t_t

◆ ModifierSpeciesReference_unsetSpecies()

int ModifierSpeciesReference_unsetSpecies ( ModifierSpeciesReference_t msr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tModifierSpeciesReference_t_t _tstructure_t.

@_tparam_t _tmsr_t _tthe_t _tModifierSpeciesReference_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 _tModifierSpeciesReference_t_t