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

The registry class for tracking package extensions. More...

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

Functions

int SBMLExtensionRegistry_addExtension (const SBMLExtension_t *extension)
 _tAdd_t _tthe_t _tgiven_t _tSBMLExtension_t_t _tto_t _tthe_t _tSBMLExtensionRegistry_t_t.
 
SBMLExtension_tSBMLExtensionRegistry_getExtension (const char *package)
 _tReturns_t _tan_t _tSBMLExtension_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tpackage_t _tURI_t _tor_t _tpackage_t _tname_t (_tstring_t).
 
int SBMLExtensionRegistry_getNumExtensions (const SBaseExtensionPoint_t *extPoint)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tSBMLExtension_t_t _tstructures_t _tfor_t _tthe_t _tgiven_t _textension_t _tpoint_t.
 
int SBMLExtensionRegistry_getNumRegisteredPackages ()
 _tReturns_t _tthe_t _tnumber_t _tof_t _tregistered_t _tpackages_t.
 
char * SBMLExtensionRegistry_getRegisteredPackageName (int index)
 _tReturns_t _tthe_t _tregistered_t _tpackage_t _tname_t _tat_t _tthe_t _tgiven_t _tindex_t
 
List_tSBMLExtensionRegistry_getRegisteredPackages ()
 _tReturns_t _ta_t _tlist_t _tof_t _tregistered_t _tpackages_t (_tsuch_t _tas_t '_tlayout_t', '_tfbc_t' _tor_t '_tcomp_t').
 
const SBasePluginCreatorBase_tSBMLExtensionRegistry_getSBasePluginCreator (const SBaseExtensionPoint_t *extPoint, const char *uri)
 _tReturns_t _tan_t _tSBasePluginCreator_t_t _tstructure_t _twith_t _tthe_t _tcombination_t _tof_t _tthe_t _tgiven_t _textension_t _tpoint_t _tand_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t.
 
SBasePluginCreatorBase_t ** SBMLExtensionRegistry_getSBasePluginCreators (const SBaseExtensionPoint_t *extPoint, int *length)
 _tReturns_t _ta_t _tcopied_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _textension_t _tpoint_t.
 
SBasePluginCreatorBase_t ** SBMLExtensionRegistry_getSBasePluginCreatorsByURI (const char *uri, int *length)
 _tReturns_t _ta_t _tcopied_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tpackage_t _textension_t.
 
int SBMLExtensionRegistry_isEnabled (const char *uri)
 _tChecks_t _tif_t _tthe_t _textension_t _twith_t _tthe_t _tgiven_t _tURI_t _tis_t _tenabled_t (@_tc_t _t1_t, _ttrue_t) _tor_t _tdisabled_t (@_tc_t _t0_t, _tfalse_t)
 
int SBMLExtensionRegistry_isRegistered (const char *uri)
 _tChecks_t _tif_t _tthe_t _textension_t _twith_t _tthe_t _tgiven_t _tURI_t _tis_t _tregistered_t (@_tc_t _t1_t, _ttrue_t) _tor_t _tnot_t (@_tc_t _t0_t, _tfalse_t)
 
int SBMLExtensionRegistry_setEnabled (const char *uri, int isEnabled)
 _tEnable_t/_tdisable_t _tthe_t _tpackage_t _twith_t _tthe_t _tgiven_t _turi_t.
 

Detailed Description

The registry class for tracking package extensions.

Author
Akiya Jouraku

Function Documentation

◆ SBMLExtensionRegistry_addExtension()

int SBMLExtensionRegistry_addExtension ( const SBMLExtension_t extension)

_tAdd_t _tthe_t _tgiven_t _tSBMLExtension_t_t _tto_t _tthe_t _tSBMLExtensionRegistry_t_t.

@_tparam_t _textension_t _tthe_t _tSBMLExtension_t_t _tstructure_t _tto_t _tbe_t _tadded_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_CONFLICT_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getExtension()

SBMLExtension_t * SBMLExtensionRegistry_getExtension ( const char *  package)

_tReturns_t _tan_t _tSBMLExtension_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tpackage_t _tURI_t _tor_t _tpackage_t _tname_t (_tstring_t).

@_tparam_t _tpackage_t _tthe_t _tURI_t _tor_t _tname_t _tof_t _tthe_t _tpackage_t _textension_t.

@_treturn_t _ta_t _tclone_t _tof_t _tthe_t _tSBMLExtension_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tpackage_t _tURI_t _tor_t _tname_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tof_t _tan_t _tinvalid_t _tpackage_t _tname_t.

@_tnote_t _tThe_t _treturned_t _textension_t _tis_t _tto_t _tbe_t _tfreed_t (_ti_t._te_t.: _tdeleted_t) _tby_t _tthe_t _tcaller_t!

@_tmemberof_t _tSBMLExtensionRegistry_t_t

Examples
spec_example1.c.

◆ SBMLExtensionRegistry_getNumExtensions()

int SBMLExtensionRegistry_getNumExtensions ( const SBaseExtensionPoint_t extPoint)

_tReturns_t _tthe_t _tnumber_t _tof_t _tSBMLExtension_t_t _tstructures_t _tfor_t _tthe_t _tgiven_t _textension_t _tpoint_t.

@_tparam_t _textPoint_t _tthe_t _tSBaseExtensionPoint_t_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tSBMLExtension_t_t _tstructures_t _tfor_t _tthe_t _tgiven_t _textension_t _tpoint_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getNumRegisteredPackages()

int SBMLExtensionRegistry_getNumRegisteredPackages ( )

_tReturns_t _tthe_t _tnumber_t _tof_t _tregistered_t _tpackages_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tregistered_t _tpackages_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getRegisteredPackageName()

char * SBMLExtensionRegistry_getRegisteredPackageName ( int  index)

_tReturns_t _tthe_t _tregistered_t _tpackage_t _tname_t _tat_t _tthe_t _tgiven_t _tindex_t

@_tparam_t _tindex_t _tzero_t _tbased_t _tindex_t _tof_t _tthe_t _tpackage_t _tname_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tpackage_t _tname_t _twith_t _tthe_t _tgiven_t _tindex_t _tor_t @_tc_t _tNULL_t

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getRegisteredPackages()

List_t * SBMLExtensionRegistry_getRegisteredPackages ( )

_tReturns_t _ta_t _tlist_t _tof_t _tregistered_t _tpackages_t (_tsuch_t _tas_t '_tlayout_t', '_tfbc_t' _tor_t '_tcomp_t').

_tThe_t _tlist_t _tcontains_t _tchar_t* _tstrings_t _tand_t _thas_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t.

@_treturn_t _tthe_t _tnames_t _tof_t _tthe_t _tregistered_t _tpackages_t _tin_t _ta_t _tlist_t

@_tmemberof_t _tSBMLExtensionRegistry_t_t

Examples
printRegisteredPackages.c.

◆ SBMLExtensionRegistry_getSBasePluginCreator()

const SBasePluginCreatorBase_t * SBMLExtensionRegistry_getSBasePluginCreator ( const SBaseExtensionPoint_t extPoint,
const char *  uri 
)

_tReturns_t _tan_t _tSBasePluginCreator_t_t _tstructure_t _twith_t _tthe_t _tcombination_t _tof_t _tthe_t _tgiven_t _textension_t _tpoint_t _tand_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t.

@_tparam_t _textPoint_t _tthe_t _tSBaseExtensionPoint_t_t. @_tparam_t _turi_t _tthe_t _tURI_t _tof_t _tthe_t _ttarget_t _tpackage_t _textension_t.

@_treturn_t _tthe_t _tSBasePluginCreator_t_t _twith_t _tthe_t _tcombination_t _tof_t _tthe_t _tgiven_t _tSBMLTypeCode_t_t _tand_t _tthe_t _tgiven_t _tURI_t _tof_t _tpackage_t _textension_t, _tor_t @_tc_t _tNULL_t _tfor_t _tinvalid_t _textensionPoint_t _tor_t _turi_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getSBasePluginCreators()

SBasePluginCreatorBase_t ** SBMLExtensionRegistry_getSBasePluginCreators ( const SBaseExtensionPoint_t extPoint,
int *  length 
)

_tReturns_t _ta_t _tcopied_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _textension_t _tpoint_t.

@_tparam_t _textPoint_t _tthe_t _tSBaseExtensionPoint_t_t. @_tparam_t _tlength_t _tpointer_t _tto_t _ta_t _tvariable_t _tholding_t _tthe_t _tlength_t _tof_t _tthe_t _tarray_t _treturned_t.

@_treturn_t _tan_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _ttypecode_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_getSBasePluginCreatorsByURI()

SBasePluginCreatorBase_t ** SBMLExtensionRegistry_getSBasePluginCreatorsByURI ( const char *  uri,
int *  length 
)

_tReturns_t _ta_t _tcopied_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tpackage_t _textension_t.

@_tparam_t _turi_t _tthe_t _tURI_t _tof_t _tthe_t _ttarget_t _tpackage_t _textension_t. @_tparam_t _tlength_t _tpointer_t _tto_t _ta_t _tvariable_t _tholding_t _tthe_t _tlength_t _tof_t _tthe_t _tarray_t _treturned_t.

@_treturn_t _tan_t _tarray_t _tof_t _tSBasePluginCreators_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tpackage_t _textension_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_isEnabled()

int SBMLExtensionRegistry_isEnabled ( const char *  uri)

_tChecks_t _tif_t _tthe_t _textension_t _twith_t _tthe_t _tgiven_t _tURI_t _tis_t _tenabled_t (@_tc_t _t1_t, _ttrue_t) _tor_t _tdisabled_t (@_tc_t _t0_t, _tfalse_t)

@_tparam_t _turi_t _tthe_t _tURI_t _tof_t _tthe_t _ttarget_t _tpackage_t.

@_treturn_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tgiven_t _tpackage_t _tis_t _tdisabled_t _tor_t _tnot_t _tregistered_t, _totherwise_t @_tc_t _t1_t (_ttrue_t) _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_isRegistered()

int SBMLExtensionRegistry_isRegistered ( const char *  uri)

_tChecks_t _tif_t _tthe_t _textension_t _twith_t _tthe_t _tgiven_t _tURI_t _tis_t _tregistered_t (@_tc_t _t1_t, _ttrue_t) _tor_t _tnot_t (@_tc_t _t0_t, _tfalse_t)

@_tparam_t _turi_t _tthe_t _tURI_t _tof_t _tthe_t _ttarget_t _tpackage_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tpackage_t _twith_t _tthe_t _tgiven_t _tURI_t _tis_t _tregistered_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t

◆ SBMLExtensionRegistry_setEnabled()

int SBMLExtensionRegistry_setEnabled ( const char *  uri,
int  isEnabled 
)

_tEnable_t/_tdisable_t _tthe_t _tpackage_t _twith_t _tthe_t _tgiven_t _turi_t.

@_tparam_t _turi_t _tthe_t _tURI_t _tof_t _tthe_t _ttarget_t _tpackage_t. @_tparam_t _tisEnabled_t _tthe_t _tbool_t _tvalue_t _tcorresponding_t _tto_t _tenabled_t (@_tc_t _tnonzero_t, _ttrue_t) _tor_t _tdisabled_t (@_tc_t _tzero_t, _tfalse_t).

@_treturn_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tgiven_t _tbool_t _tvalue_t _tis_t _tfalse_t _tor_t _tthe_t _tgiven_t _tpackage_t _tis_t _tnot_t _tregistered_t, _totherwise_t @_tc_t _t1_t (_ttrue_t) _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLExtensionRegistry_t_t