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

Definition of SBMLExtension_t, the core component of SBML package extension. More...

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

Data Structures

struct  packageErrorTableEntry
 
struct  packageErrorTableEntryV2
 
struct  packageErrorTableEntryV3
 
struct  packageReferenceEntry
 @_tcond_t _tdoxygenLibsbmlInternal_t More...
 
struct  packageReferenceEntryV2
 
struct  packageReferenceEntryV3
 

Macros

#define EXTENSION_CREATE_NS(type, variable, sbmlns)    EXTENSION_CREATE_NS_WITH_VERSION(type,variable,sbmlns,1)
 
#define EXTENSION_CREATE_NS_WITH_VERSION(type, variable, sbmlns, version)
 @_tclass_t _tdoc_virtual_method_for_l2namespaces_t
 

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)
 @_tendcond_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

Definition of SBMLExtension_t, the core component of SBML package extension.

Author
Akiya Jouraku

Data Structure Documentation

◆ packageErrorTableEntry

struct packageErrorTableEntry
Data Fields
unsigned int category
unsigned int code
unsigned int l3v1v1_severity
const char * message
packageReferenceEntry reference
const char * shortMessage

◆ packageErrorTableEntryV2

struct packageErrorTableEntryV2
Data Fields
unsigned int category
unsigned int code
unsigned int l3v1v1_severity
unsigned int l3v1v2_severity
const char * message
packageReferenceEntryV2 reference
const char * shortMessage

◆ packageErrorTableEntryV3

struct packageErrorTableEntryV3
Data Fields
unsigned int category
unsigned int code
unsigned int l3v1v1_severity
unsigned int l3v1v2_severity
unsigned int l3v1v3_severity
const char * message
packageReferenceEntryV3 reference
const char * shortMessage

◆ packageReferenceEntry

struct packageReferenceEntry
Data Fields
const char * ref_l3v1v1

◆ packageReferenceEntryV2

struct packageReferenceEntryV2
Data Fields
const char * ref_l3v1v1
const char * ref_l3v1v2

◆ packageReferenceEntryV3

struct packageReferenceEntryV3
Data Fields
const char * ref_l3v1v1
const char * ref_l3v1v2
const char * ref_l3v1v3

Macro Definition Documentation

◆ EXTENSION_CREATE_NS

#define EXTENSION_CREATE_NS (   type,
  variable,
  sbmlns 
)     EXTENSION_CREATE_NS_WITH_VERSION(type,variable,sbmlns,1)

◆ EXTENSION_CREATE_NS_WITH_VERSION

#define EXTENSION_CREATE_NS_WITH_VERSION (   type,
  variable,
  sbmlns,
  version 
)
Value:
type* variable;\
{\
XMLNamespaces* xmlns = sbmlns->getNamespaces();\
variable = dynamic_cast<type*>(sbmlns);\
if (variable == NULL)\
{\
try\
{\
variable = new type(sbmlns->getLevel(), sbmlns->getVersion(), version);\
}\
catch (SBMLExtensionException e)\
{\
variable = new type(sbmlns->getLevel(), 1, version);\
}\
for (int i = 0; xmlns != NULL && i < xmlns->getNumNamespaces(); ++i)\
{\
if (!variable->getNamespaces()->hasURI(xmlns->getURI(i)))\
variable->getNamespaces()->add(xmlns->getURI(i), xmlns->getPrefix(i));\
}\
}\
else { variable = new type(*variable); }\
}

@_tclass_t _tdoc_virtual_method_for_l2namespaces_t

@_tpar_t _tThis_t _tmethod_t _tis_t _trelated_t _tto_t _tspecial_t _tfacilities_t _tdesigned_t _tto_t _tsupport_t _tlegacy_t _tbehaviors_t _tsurrounding_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tmodels_t. _tDue_t _tto_t _tthe_t _thistorical_t _tbackground_t _tof_t _tthe_t _tSBML_t Layout_t _tpackage_t, _tlibSBML_t _timplements_t _tspecial_t _tbehavior_t _tfor_t _tthat_t _tpackage_t: _tit_t @_tem_t _talways_t _tcreates_t _ta_t Layout_t _tplugin_t _tobject_t _tfor_t _tany_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tdocument_t _tit_t _treads_t _tin_t, _tregardless_t _tof_t _twhether_t _tthat_t _tdocument_t _tactually_t _tuses_t Layout_t _tconstructs_t. _tSince_t _tLevel_t&_tnbsp_t;_t2_t _tdoes_t _tnot_t _tuse_t _tnamespaces_t _ton_t _tthe_t _ttop_t _tlevel_t _tof_t _tthe_t _tSBML_t _tdocument_t _tobject_t, _tlibSBML_t _tsimply_t _tkeys_t _toff_t _tthe_t _tfact_t _tthat_t _tthe_t _tmodel_t _tis_t _ta_t _tLevel_t&_tnbsp_t;_t2_t _tmodel_t. _tTo_t _tallow_t _tthe_t _textensions_t _tfor_t _tthe_t Layout_t _tand_t Render_t (_tand_t _tpossibly_t _tother_t) _tpackages_t _tto_t _tsupport_t _tthis_t _tbehavior_t, _tthe_t _tSBMLExtension_t _tclass_t _tcontains_t _tspecial_t _tmethods_t _tto_t _tallow_t _tpackages_t _tto_t _thook_t _tthemselves_t _tinto_t _tthe_t _tLevel_t&_tnbsp_t;_t2_t _tparsing_t _tapparatus_t _twhen_t _tnecessary_t.

@_tif_t _tclike_t _tThis_t _tvirtual_t _tmethod_t _tshould_t _tbe_t _toverridden_t _tby_t _tall_t _tpackage_t _textensions_t _tthat_t _twant_t _tto_t _tserialize_t _tto_t _tan_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tannotation_t. _tIn_t _tLevel_t&_tnbsp_t;_t2_t, _tthe_t _tXML_t _tnamespace_t _tdeclaration_t _tfor_t _tthe_t _tpackage_t _tis_t _tnot_t _tplaced_t _ton_t _tthe_t _ttop_t-_tlevel_t _tSBML_t _tdocument_t _tobject_t _tbut_t _trather_t _tinside_t _tindividual_t _tannotations_t. _taddL2Namespaces_t() _tis_t _tinvoked_t _tautomatically_t _tfor_t _tLevel_t&_tnbsp_t;_t2_t _tdocuments_t _twhen_t _tan_t _tSBMLExtensionNamespace_t _tobject_t _tis_t _tcreated_t; _tremoveL2Namespaces_t() _tis_t _tautomatically_t _tinvoked_t _tby_t _tSBMLDocument_t _tto_t _tprevent_t _tthe_t _tnamespace_t(_ts_t) _tfrom_t _tbeing_t _tput_t _ton_t _tthe_t _ttop_t-_tlevel_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _telement_t (_tbecause_t _tLevel_t&_tnbsp_t;_t2_t _tdoesn_t'_tt_t _tsupport_t _tnamespaces_t _tthere_t); _tand_t _tenableL2NamespaceForDocument_t() _tis_t _tcalled_t _tautomatically_t _twhen_t _tany_t _tSBML_t _tdocument_t (_tof_t _tany_t _tLevel_t/_tVersion_t) _tis_t _tread_t _tin_t. @_tendif_t

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)

@_tendcond_t

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_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 _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tSBMLExtension_t_t _tstructure_t.

@_tmemberof_t _tSBMLExtension_t_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

◆ 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