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

Definition of CompModelPlugin_t, the plugin class of comp package for the Model_t element. More...

This graph shows which files directly or indirectly include this file:

Functions

int CompModelPlugin_addPort (CompModelPlugin_t *cmp, const Port_t *p)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tto_t _tthis_t _tCompModelPlugin_t_t.
 
int CompModelPlugin_addSubmodel (CompModelPlugin_t *cmp, const Submodel_t *s)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _tthis_t _tCompModelPlugin_t_t.
 
Port_tCompModelPlugin_createPort (CompModelPlugin_t *cmp)
 _tCreates_t _ta_t _tnew_t _tPort_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tPort_t_t _tobject_t _tcreated_t.
 
Submodel_tCompModelPlugin_createSubmodel (CompModelPlugin_t *cmp)
 _tCreates_t _ta_t _tnew_t _tSubmodel_t_t, _tadds_t _tit_t _tto_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _tthe_t _tSubmodel_t_t _tcreated_t.
 
ListOf_tCompModelPlugin_getListOfPorts (CompModelPlugin_t *cmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tPort_t_t _tobjects_t _tfrom_t _tthis_t _tCompModelPlugin_t_t.
 
ListOf_tCompModelPlugin_getListOfSubmodels (CompModelPlugin_t *cmp)
 _tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tSubmodel_t_t _tobjects_t _tfrom_t _tthis_t _tCompModelPlugin_t_t.
 
unsigned int CompModelPlugin_getNumPorts (CompModelPlugin_t *cmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tPort_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.
 
unsigned int CompModelPlugin_getNumSubmodels (CompModelPlugin_t *cmp)
 _tGet_t _tthe_t _tnumber_t _tof_t _tSubmodel_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.
 
Port_tCompModelPlugin_getPort (CompModelPlugin_t *cmp, unsigned int n)
 _tGet_t _ta_t _tPort_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t.
 
Port_tCompModelPlugin_getPortById (CompModelPlugin_t *cmp, const char *sid)
 _tGet_t _ta_t _tPort_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
Submodel_tCompModelPlugin_getSubmodel (CompModelPlugin_t *cmp, unsigned int n)
 _tGet_t _ta_t _tSubmodel_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t.
 
Submodel_tCompModelPlugin_getSubmodelById (CompModelPlugin_t *cmp, const char *sid)
 _tGet_t _ta_t _tSubmodel_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
Port_tCompModelPlugin_removePort (CompModelPlugin_t *cmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tPort_t_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Submodel_tCompModelPlugin_removeSubmodel (CompModelPlugin_t *cmp, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tSubmodel_t_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Detailed Description

Definition of CompModelPlugin_t, the plugin class of comp package for the Model_t element.

Author
Lucian Smith

Function Documentation

◆ CompModelPlugin_addPort()

int CompModelPlugin_addPort ( CompModelPlugin_t cmp,
const Port_t p 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPort_t_t _tto_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tPort_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tp_t _tthe_t _tPort_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_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}

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_addSubmodel()

int CompModelPlugin_addSubmodel ( CompModelPlugin_t cmp,
const Submodel_t s 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSubmodel_t_t _tto_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tSubmodel_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _ts_t _tthe_t _tSubmodel_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_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}

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_createPort()

Port_t * CompModelPlugin_createPort ( CompModelPlugin_t cmp)

_tCreates_t _ta_t _tnew_t _tPort_t_t _tobject_t, _tadds_t _tit_t _tto_t _tthis_t _tCompModelPlugin_t_t _tobject_t _tand_t _treturns_t _tthe_t _tPort_t_t _tobject_t _tcreated_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tPort_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tPort_t_t _tobject_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_createSubmodel()

Submodel_t * CompModelPlugin_createSubmodel ( CompModelPlugin_t cmp)

_tCreates_t _ta_t _tnew_t _tSubmodel_t_t, _tadds_t _tit_t _tto_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _tthe_t _tSubmodel_t_t _tcreated_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tSubmodel_t_t _tshould_t _tbe_t _tadded_t.

@_treturn_t _ta_t _tnew_t _tSubmodel_t_t _tinstance_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getListOfPorts()

ListOf_t * CompModelPlugin_getListOfPorts ( CompModelPlugin_t cmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tPort_t_t _tobjects_t _tfrom_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _twhose_t _tListOfPorts_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfPorts_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tCompModelPlugin_addPort_t() @_tsee_t _tCompModelPlugin_createPort_t() @_tsee_t _tCompModelPlugin_getPortById_t() @_tsee_t _tCompModelPlugin_getPort_t() @_tsee_t _tCompModelPlugin_getNumPorts_t() @_tsee_t _tCompModelPlugin_removePort_t()

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getListOfSubmodels()

ListOf_t * CompModelPlugin_getListOfSubmodels ( CompModelPlugin_t cmp)

_tReturns_t _ta_t _tListOf_t_t * _tcontaining_t _tSubmodel_t_t _tobjects_t _tfrom_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _twhose_t _tListOfSubmodels_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tListOfSubmodels_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tas_t _ta_t _tListOf_t_t *.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tsee_t _tCompModelPlugin_addSubmodel_t() @_tsee_t _tCompModelPlugin_createSubmodel_t() @_tsee_t _tCompModelPlugin_getSubmodelById_t() @_tsee_t _tCompModelPlugin_getSubmodel_t() @_tsee_t _tCompModelPlugin_getNumSubmodels_t() @_tsee_t _tCompModelPlugin_removeSubmodel_t()

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getNumPorts()

unsigned int CompModelPlugin_getNumPorts ( CompModelPlugin_t cmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tPort_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tPort_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getNumSubmodels()

unsigned int CompModelPlugin_getNumSubmodels ( CompModelPlugin_t cmp)

_tGet_t _tthe_t _tnumber_t _tof_t _tSubmodel_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tSubmodel_t_t _tobjects_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getPort()

Port_t * CompModelPlugin_getPort ( CompModelPlugin_t cmp,
unsigned int  n 
)

_tGet_t _ta_t _tPort_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tPort_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tPort_t_t _tin_t _tthe_t _tListOfPorts_t _twithin_t _tthis_t _tCompModelPlugin_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getPortById()

Port_t * CompModelPlugin_getPortById ( CompModelPlugin_t cmp,
const char *  sid 
)

_tGet_t _ta_t _tPort_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tPort_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tPort_t_t _tin_t _tthe_t _tListOfPorts_t _twithin_t _tthis_t _tCompModelPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tPort_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getSubmodel()

Submodel_t * CompModelPlugin_getSubmodel ( CompModelPlugin_t cmp,
unsigned int  n 
)

_tGet_t _ta_t _tSubmodel_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tSubmodel_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tSubmodel_t_t _tin_t _tthe_t _tListOfSubmodels_t _twithin_t _tthis_t _tCompModelPlugin_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_getSubmodelById()

Submodel_t * CompModelPlugin_getSubmodelById ( CompModelPlugin_t cmp,
const char *  sid 
)

_tGet_t _ta_t _tSubmodel_t_t _tfrom_t _tthe_t _tCompModelPlugin_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tSubmodel_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tSubmodel_t_t _tin_t _tthe_t _tListOfSubmodels_t _twithin_t _tthis_t _tCompModelPlugin_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tSubmodel_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_removePort()

Port_t * CompModelPlugin_removePort ( CompModelPlugin_t cmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tPort_t_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tPort_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tPort_t_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t

◆ CompModelPlugin_removeSubmodel()

Submodel_t * CompModelPlugin_removeSubmodel ( CompModelPlugin_t cmp,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tSubmodel_t_t _tfrom_t _tthis_t _tCompModelPlugin_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tcmp_t _tthe_t _tCompModelPlugin_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 _tSubmodel_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tSubmodel_t_t _tin_t _tthis_t _tCompModelPlugin_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tCompModelPlugin_t_t