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

Definition of QualModelPlugin_t, the plugin class of qual package for the Model_t element. More...

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

Functions

int QualModelPlugin_addQualitativeSpecies (QualModelPlugin_t *qmp, const QualitativeSpecies_t *qs)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tQualitativeSpecies_t_t _tto_t _tthis_t _tQualModelPlugin_t_t.
 
int QualModelPlugin_addTransition (QualModelPlugin_t *qmp, const Transition_t *t)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tTransition_t_t _tto_t _tthis_t _tQualModelPlugin_t_t.
 
QualitativeSpecies_tQualModelPlugin_createQualitativeSpecies (QualModelPlugin_t *qmp)
 _tCreates_t _ta_t _tnew_t _tQualitativeSpecies_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tQualModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tQualitativeSpecies_t_t _tobject_t _tcreated_t.
 
Transition_tQualModelPlugin_createTransition (QualModelPlugin_t *qmp)
 _tCreates_t _ta_t _tnew_t _tTransition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tQualModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tTransition_t_t _tobject_t _tcreated_t.
 
ListOf_tQualModelPlugin_getListOfQualitativeSpecies (QualModelPlugin_t *qmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tQualitativeSpecies_t_t _tobjects_t _tfrom_t _tthis_t _tQualModelPlugin_t_t.
 
ListOf_tQualModelPlugin_getListOfTransitions (QualModelPlugin_t *qmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tTransition_t_t _tobjects_t _tfrom_t _tthis_t _tQualModelPlugin_t_t.
 
unsigned int QualModelPlugin_getNumQualitativeSpecies (QualModelPlugin_t *qmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tQualitativeSpecies_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.
 
unsigned int QualModelPlugin_getNumTransitions (QualModelPlugin_t *qmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tTransition_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.
 
const QualitativeSpecies_tQualModelPlugin_getQualitativeSpecies (QualModelPlugin_t *qmp, unsigned int n)
 _tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t.
 
const QualitativeSpecies_tQualModelPlugin_getQualitativeSpeciesByCompartment (QualModelPlugin_t *qmp, const char *sid)
 _tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tthe_t _tCompartment_t _tto_t _twhich_t _tit_t _trefers_t.
 
const QualitativeSpecies_tQualModelPlugin_getQualitativeSpeciesById (QualModelPlugin_t *qmp, const char *sid)
 _tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
const Transition_tQualModelPlugin_getTransition (QualModelPlugin_t *qmp, unsigned int n)
 _tGet_t _ta_t _tTransition_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t.
 
const Transition_tQualModelPlugin_getTransitionById (QualModelPlugin_t *qmp, const char *sid)
 _tGet_t _ta_t _tTransition_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
QualitativeSpecies_tQualModelPlugin_removeQualitativeSpecies (QualModelPlugin_t *qmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tQualitativeSpecies_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
QualitativeSpecies_tQualModelPlugin_removeQualitativeSpeciesById (QualModelPlugin_t *qmp, const char *sid)
 _tRemoves_t _tthe_t _tQualitativeSpecies_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Transition_tQualModelPlugin_removeTransition (QualModelPlugin_t *qmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tTransition_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Transition_tQualModelPlugin_removeTransitionById (QualModelPlugin_t *qmp, const char *sid)
 _tRemoves_t _tthe_t _tTransition_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Definition of QualModelPlugin_t, the plugin class of qual package for the Model_t element.

Author
Akiya Jouraku

Function Documentation

◆ QualModelPlugin_addQualitativeSpecies()

int QualModelPlugin_addQualitativeSpecies ( QualModelPlugin_t qmp,
const QualitativeSpecies_t qs 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tQualitativeSpecies_t_t _tto_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tQualitativeSpecies_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tqs_t _tthe_t _tQualitativeSpecies_t_t _tobject_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_addTransition()

int QualModelPlugin_addTransition ( QualModelPlugin_t qmp,
const Transition_t t 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tTransition_t_t _tto_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tTransition_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tt_t _tthe_t _tTransition_t_t _tobject_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_createQualitativeSpecies()

QualitativeSpecies_t * QualModelPlugin_createQualitativeSpecies ( QualModelPlugin_t qmp)

_tCreates_t _ta_t _tnew_t _tQualitativeSpecies_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tQualModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tQualitativeSpecies_t_t _tobject_t _tcreated_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tQualitativeSpecies_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tQualitativeSpecies_t_t _tobject_t _tinstance_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_createTransition()

Transition_t * QualModelPlugin_createTransition ( QualModelPlugin_t qmp)

_tCreates_t _ta_t _tnew_t _tTransition_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tQualModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tTransition_t_t _tobject_t _tcreated_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tTransition_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tTransition_t_t _tobject_t _tinstance_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getListOfQualitativeSpecies()

ListOf_t * QualModelPlugin_getListOfQualitativeSpecies ( QualModelPlugin_t qmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tQualitativeSpecies_t_t _tobjects_t _tfrom_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _twhose_t _tListOfQualitativeSpecies_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfQualitativeSpecies_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getListOfTransitions()

ListOf_t * QualModelPlugin_getListOfTransitions ( QualModelPlugin_t qmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tTransition_t_t _tobjects_t _tfrom_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _twhose_t _tListOfTransitions_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfTransitions_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getNumQualitativeSpecies()

unsigned int QualModelPlugin_getNumQualitativeSpecies ( QualModelPlugin_t qmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tQualitativeSpecies_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tQualitativeSpecies_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getNumTransitions()

unsigned int QualModelPlugin_getNumTransitions ( QualModelPlugin_t qmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tTransition_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tTransition_t_t _tobjects_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getQualitativeSpecies()

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpecies ( QualModelPlugin_t qmp,
unsigned int  n 
)

_tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tQualitativeSpecies_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tQualitativeSpecies_t_t _tin_t _tthe_t _tListOfQualitativeSpecies_t _twithin_t _tthis_t _tQualModelPlugin_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getQualitativeSpeciesByCompartment()

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpeciesByCompartment ( QualModelPlugin_t qmp,
const char *  sid 
)

_tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tthe_t _tCompartment_t _tto_t _twhich_t _tit_t _trefers_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcompartment_t _tattribute_t _tof_t _tthe_t _tQualitativeSpecies_t_t _tobject_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tfirst_t _tQualitativeSpecies_t_t _tin_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tthe_t _tgiven_t _tcompartment_t _tattribute_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tQualitativeSpecies_t_t _texists_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getQualitativeSpeciesById()

const QualitativeSpecies_t * QualModelPlugin_getQualitativeSpeciesById ( QualModelPlugin_t qmp,
const char *  sid 
)

_tGet_t _ta_t _tQualitativeSpecies_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tQualitativeSpecies_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tQualitativeSpecies_t_t _tin_t _tthe_t _tListOfQualitativeSpecies_t _twithin_t _tthis_t _tQualModelPlugin_t _twith_t _tthe_t _tgiven_t _tid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tQualitativeSpecies_t_t _texists_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getTransition()

const Transition_t * QualModelPlugin_getTransition ( QualModelPlugin_t qmp,
unsigned int  n 
)

_tGet_t _ta_t _tTransition_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tTransition_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tTransition_t_t _tin_t _tthe_t _tListOfTransitions_t _twithin_t _tthis_t _tQualModelPlugin_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_getTransitionById()

const Transition_t * QualModelPlugin_getTransitionById ( QualModelPlugin_t qmp,
const char *  sid 
)

_tGet_t _ta_t _tTransition_t_t _tfrom_t _tthe_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tTransition_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tTransition_t_t _tin_t _tthe_t _tListOfTransitions_t _twithin_t _tthis_t _tQualModelPlugin_t _twith_t _tthe_t _tgiven_t _tid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tTransition_t_t _texists_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_removeQualitativeSpecies()

QualitativeSpecies_t * QualModelPlugin_removeQualitativeSpecies ( QualModelPlugin_t qmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tQualitativeSpecies_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tQualitativeSpecies_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tQualitativeSpecies_t_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_removeQualitativeSpeciesById()

QualitativeSpecies_t * QualModelPlugin_removeQualitativeSpeciesById ( QualModelPlugin_t qmp,
const char *  sid 
)

_tRemoves_t _tthe_t _tQualitativeSpecies_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tQualitativeSpecies_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tQualitativeSpecies_t_t _tin_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tQualitativeSpecies_t_t _texists_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_removeTransition()

Transition_t * QualModelPlugin_removeTransition ( QualModelPlugin_t qmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tTransition_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tTransition_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tTransition_t_t _tin_t _tthis_t _tQualModelPlugin_t_t.

@_tmemberof_t _tQualModelPlugin_t_t

◆ QualModelPlugin_removeTransitionById()

Transition_t * QualModelPlugin_removeTransitionById ( QualModelPlugin_t qmp,
const char *  sid 
)

_tRemoves_t _tthe_t _tTransition_t_t _tfrom_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tqmp_t _tthe_t _tQualModelPlugin_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tTransition_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tTransition_t_t _tin_t _tthis_t _tQualModelPlugin_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tTransition_t_t _texists_t.

@_tmemberof_t _tQualModelPlugin_t_t