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

Implementation of SBMLExtension_t, the base class of package extensions. More...

Include dependency graph for SBMLExtension.cpp:

Functions

int SBMLExtension_addSBasePluginCreator (SBMLExtension_t *ext, SBasePluginCreatorBase_t *sbaseExt)
 _tAdds_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t _tto_t _tthis_t _tpackage_t _textension_t.
 
SBMLExtension_tSBMLExtension_clone (SBMLExtension_t *ext)
 @_tcond_t _tdoxygenIgnored_t
 
int SBMLExtension_free (SBMLExtension_t *ext)
 _tFrees_t _tthe_t _tgiven_t _tSBMLExtension_t_t _tstructure_t
 
unsigned int SBMLExtension_getLevel (SBMLExtension_t *ext, const char *uri)
 _tReturns_t _tthe_t _tSBML_t _tlevel_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.
 
const char * SBMLExtension_getName (SBMLExtension_t *ext)
 _tReturns_t _tthe_t _tname_t _tof_t _tthe_t _tpackage_t _textension_t.
 
int SBMLExtension_getNumOfSBasePlugins (SBMLExtension_t *ext)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tSBasePlugin_t_t _tstructures_t _tstored_t _tin_t _tthe_t _tstructure_t.
 
int SBMLExtension_getNumOfSupportedPackageURI (SBMLExtension_t *ext)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackage_t _tnamespaces_t (_tpackage_t _tversions_t) _tfor_t _tthis_t _tpackage_t _textension_t.
 
unsigned int SBMLExtension_getPackageVersion (SBMLExtension_t *ext, const char *uri)
 _tReturns_t _tthe_t _tpackage_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.
 
SBasePluginCreatorBase_tSBMLExtension_getSBasePluginCreator (SBMLExtension_t *ext, SBaseExtensionPoint_t *extPoint)
 _tReturns_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _tbound_t _tto_t _tthe_t _tgiven_t _textension_t _tpoint_t.
 
SBasePluginCreatorBase_tSBMLExtension_getSBasePluginCreatorByIndex (SBMLExtension_t *ext, unsigned int index)
 _tReturns_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tindex_t.
 
SBMLNamespaces_tSBMLExtension_getSBMLExtensionNamespaces (SBMLExtension_t *ext, const char *uri)
 _tReturns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _turi_t.
 
const char * SBMLExtension_getStringFromTypeCode (SBMLExtension_t *ext, int typeCode)
 _tThis_t _tmethod_t _ttakes_t _ta_t _ttype_t _tcode_t _tof_t _tthis_t _tpackage_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.
 
const char * SBMLExtension_getSupportedPackageURI (SBMLExtension_t *ext, unsigned int index)
 _tReturns_t _tthe_t _tpackage_t _tURI_t (_tpackage_t _tversion_t) _tfor_t _tthe_t _tgiven_t _tindex_t.
 
const char * SBMLExtension_getURI (SBMLExtension_t *ext, unsigned int sbmlLevel, unsigned int sbmlVersion, unsigned int pkgVersion)
 _tReturns_t _tthe_t _turi_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tSBML_t _tlevel_t, _tSBML_t _tversion_t, _tand_t _tpackage_t _tversion_t _tfor_t _tthis_t _textension_t.
 
unsigned int SBMLExtension_getVersion (SBMLExtension_t *ext, const char *uri)
 _tReturns_t _tthe_t _tSBML_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.
 
int SBMLExtension_isEnabled (SBMLExtension_t *ext)
 _tCheck_t _tif_t _tthis_t _tpackage_t _tis_t _tenabled_t _tor_t _tdisabled_t.
 
int SBMLExtension_isSupported (SBMLExtension_t *ext, const char *uri)
 _tReturns_t _ta_t _tflag_t _tindicating_t _twhether_t _tthe_t _tgiven_t _tURI_t (_tpackage_t _tversion_t) _tis_t _tsupported_t _tby_t _tthis_t _tpackage_t _textension_t.
 
int SBMLExtension_setEnabled (SBMLExtension_t *ext, int isEnabled)
 _tEnable_t/_tdisable_t _tthis_t _tpackage_t.
 

Detailed Description

Implementation of SBMLExtension_t, the base class of package extensions.

Author
Akiya Jouraku

Function Documentation

◆ SBMLExtension_addSBasePluginCreator()

int SBMLExtension_addSBasePluginCreator ( SBMLExtension_t ext,
SBasePluginCreatorBase_t sbaseExt 
)

_tAdds_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t _tto_t _tthis_t _tpackage_t _textension_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t _tto_t _tbe_t _tfreed_t. @_tparam_t _tsbaseExt_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t _tbound_t _tto_t _tsome_t _tSBML_t _telement_t _tand_t _tcreates_t _ta_t _tcorresponding_t _tSBasePlugin_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_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_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_clone()

SBMLExtension_t * SBMLExtension_clone ( SBMLExtension_t ext)

@_tcond_t _tdoxygenIgnored_t

@_tendcond_t

◆ SBMLExtension_free()

int SBMLExtension_free ( SBMLExtension_t ext)

_tFrees_t _tthe_t _tgiven_t _tSBMLExtension_t_t _tstructure_t

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t _tto_t _tbe_t _tfreed_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_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getLevel()

unsigned int SBMLExtension_getLevel ( SBMLExtension_t ext,
const char *  uri 
)

_tReturns_t _tthe_t _tSBML_t _tlevel_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tstring_t _tof_t _tURI_t _tthat_t _trepresents_t _ta_t _tversions_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _tthe_t _tSBML_t _tlevel_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getName()

const char * SBMLExtension_getName ( SBMLExtension_t ext)

_tReturns_t _tthe_t _tname_t _tof_t _tthe_t _tpackage_t _textension_t.

(_te_t._tg_t. "_tlayout_t", "_tmulti_t").

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tpackage_t _textension_t. (_te_t._tg_t. "_tlayout_t", "_tmulti_t").

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getNumOfSBasePlugins()

int SBMLExtension_getNumOfSBasePlugins ( SBMLExtension_t ext)

_tReturns_t _tthe_t _tnumber_t _tof_t _tSBasePlugin_t_t _tstructures_t _tstored_t _tin_t _tthe_t _tstructure_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tSBasePlugin_t_t _tstructures_t _tstored_t _tin_t _tthe_t _tstructure_t, _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getNumOfSupportedPackageURI()

int SBMLExtension_getNumOfSupportedPackageURI ( SBMLExtension_t ext)

_tReturns_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackage_t _tnamespaces_t (_tpackage_t _tversions_t) _tfor_t _tthis_t _tpackage_t _textension_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackage_t _tnamespaces_t (_tpackage_t _tversions_t) _tfor_t _tthis_t _tpackage_t _textension_t _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getPackageVersion()

unsigned int SBMLExtension_getPackageVersion ( SBMLExtension_t ext,
const char *  uri 
)

_tReturns_t _tthe_t _tpackage_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tstring_t _tof_t _tURI_t _tthat_t _trepresents_t _ta_t _tversions_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _tthe_t _tpackage_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getSBasePluginCreator()

SBasePluginCreatorBase_t * SBMLExtension_getSBasePluginCreator ( SBMLExtension_t ext,
SBaseExtensionPoint_t extPoint 
)

_tReturns_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _tbound_t _tto_t _tthe_t _tgiven_t _textension_t _tpoint_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _textPoint_t _tthe_t _tSBaseExtensionPoint_t_t _tto_t _twhich_t _tthe_t _treturned_t _tSBasePluginCreatorBase_t_t _tstructure_t _tbound_t.

@_treturn_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _tbound_t _tto_t _tthe_t _tgiven_t _textension_t _tpoint_t, _tor_t @_tc_t _tNULL_t _tfor_t _tinvalid_t _textension_t _tof_t _textension_t _tpoint_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getSBasePluginCreatorByIndex()

SBasePluginCreatorBase_t * SBMLExtension_getSBasePluginCreatorByIndex ( SBMLExtension_t ext,
unsigned int  index 
)

_tReturns_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _treturned_t _tSBasePluginCreatorBase_t_t _tstructure_t _tfor_t _tthis_t _tpackage_t _textension_t.

@_treturn_t _tan_t _tSBasePluginCreatorBase_t_t _tstructure_t _tof_t _tthis_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tindex_t, _tor_t @_tc_t _tNULL_t _tfor_t _tan_t _tinvalid_t _textension_t _tstructure_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getSBMLExtensionNamespaces()

SBMLNamespaces_t * SBMLExtension_getSBMLExtensionNamespaces ( SBMLExtension_t ext,
const char *  uri 
)

_tReturns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _turi_t.

_tNULL_t _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tgiven_t _turi_t _tis_t _tnot_t _tdefined_t _tin_t _tthe_t _tcorresponding_t _tpackage_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tstring_t _tof_t _tURI_t _tthat_t _trepresents_t _tone_t _tof_t _tversions_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _turi_t. _tNULL_t _twill_t _tbe_t _treturned_t _tif_t _tthe_t _tgiven_t _turi_t _tis_t _tnot_t _tdefined_t _tin_t _tthe_t _tcorresponding_t _tpackage_t _tor_t _tan_t _tinvalid_t _textension_t _tstructure_t _twas_t _tprovided_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getStringFromTypeCode()

const char * SBMLExtension_getStringFromTypeCode ( SBMLExtension_t ext,
int  typeCode 
)

_tThis_t _tmethod_t _ttakes_t _ta_t _ttype_t _tcode_t _tof_t _tthis_t _tpackage_t _tand_t _treturns_t _ta_t _tstring_t _trepresenting_t _tthe_t _tcode_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _ttypeCode_t _tthe_t _ttypeCode_t _tsupported_t _tby_t _tthe_t _tpackage_t.

@_treturn_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tgiven_t _ttypecode_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tan_t _tinvalid_t _textension_t _twas_t _tprovided_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getSupportedPackageURI()

const char * SBMLExtension_getSupportedPackageURI ( SBMLExtension_t ext,
unsigned int  index 
)

_tReturns_t _tthe_t _tpackage_t _tURI_t (_tpackage_t _tversion_t) _tfor_t _tthe_t _tgiven_t _tindex_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tsupported_t _tpackage_t _turi_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tpackage_t _tURI_t (_tpackage_t _tversion_t) _tfor_t _tthe_t _tgiven_t _tindex_t _tor_t @_tc_t _tNULL_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_getURI()

const char * SBMLExtension_getURI ( SBMLExtension_t ext,
unsigned int  sbmlLevel,
unsigned int  sbmlVersion,
unsigned int  pkgVersion 
)

_tReturns_t _tthe_t _turi_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tSBML_t _tlevel_t, _tSBML_t _tversion_t, _tand_t _tpackage_t _tversion_t _tfor_t _tthis_t _textension_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _tsbmlLevel_t _tthe_t _tlevel_t _tof_t _tSBML_t. @_tparam_t _tsbmlVersion_t _tthe_t _tversion_t _tof_t _tSBML_t. @_tparam_t _tpkgVersion_t _tthe_t _tversion_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _ta_t _tstring_t _tof_t _tthe_t _tpackage_t _tURI_t

@_tmemberof_t _tSBMLExtension_t_t

Examples
spec_example1.c.

◆ SBMLExtension_getVersion()

unsigned int SBMLExtension_getVersion ( SBMLExtension_t ext,
const char *  uri 
)

_tReturns_t _tthe_t _tSBML_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tstring_t _tof_t _tURI_t _tthat_t _trepresents_t _ta_t _tversions_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _tthe_t _tSBML_t _tversion_t _tassociated_t _twith_t _tthe_t _tgiven_t _tURI_t _tof_t _tthis_t _tpackage_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_isEnabled()

int SBMLExtension_isEnabled ( SBMLExtension_t ext)

_tCheck_t _tif_t _tthis_t _tpackage_t _tis_t _tenabled_t _tor_t _tdisabled_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _tenabled_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t. _tIf_t _tthe_t _textension_t _tis_t _tinvalid_t, @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_isSupported()

int SBMLExtension_isSupported ( SBMLExtension_t ext,
const char *  uri 
)

_tReturns_t _ta_t _tflag_t _tindicating_t _twhether_t _tthe_t _tgiven_t _tURI_t (_tpackage_t _tversion_t) _tis_t _tsupported_t _tby_t _tthis_t _tpackage_t _textension_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tpackage_t _turi_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tURI_t (_tpackage_t _tversion_t) _tis_t _tsupported_t _tby_t _tthis_t _tpackage_t _textension_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tSBMLExtension_t_t

◆ SBMLExtension_setEnabled()

int SBMLExtension_setEnabled ( SBMLExtension_t ext,
int  isEnabled 
)

_tEnable_t/_tdisable_t _tthis_t _tpackage_t.

@_tparam_t _text_t _tthe_t _tSBMLExtension_t_t _tstructure_t. @_tparam_t _tisEnabled_t _tthe_t _tvalue_t _tto_t _tset_t : @_tc_t _t1_t (_ttrue_t; _tenabled_t) _tor_t @_tc_t _t0_t (_tfalse_t; _tdisabled_t).

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tfunction_t _tcall_t _tsucceeded_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t. _tIf_t _tthe_t _textension_t _tis_t _tinvalid_t, @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLExtension_t_t