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

Definition of SBasePluginCreatorBase_t, the base class of SBasePlugin_t creator classes. More...

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

Functions

SBasePluginCreatorBase_tSBasePluginCreator_clone (SBasePluginCreatorBase_t *creator)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t
 
SBasePlugin_tSBasePluginCreator_createPlugin (SBasePluginCreatorBase_t *creator, const char *uri, const char *prefix, const XMLNamespaces_t *xmlns)
 _tCreates_t _tan_t _tSBasePlugin_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _turi_t _tand_t _tthe_t _tprefix_t _tof_t _tthe_t _ttarget_t _tpackage_t _textension_t.
 
int SBasePluginCreator_free (SBasePluginCreatorBase_t *creator)
 _tFrees_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t
 
unsigned int SBasePluginCreator_getNumOfSupportedPackageURI (SBasePluginCreatorBase_t *creator)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackages_t _tby_t _tthe_t _tgiven_t _tcreator_t _tstructure_t.
 
char * SBasePluginCreator_getSupportedPackageURI (SBasePluginCreatorBase_t *creator, unsigned int index)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tpackage_t _turi_t _twith_t _tthe_t _tspecified_t _tindex_t.
 
const SBaseExtensionPoint_tSBasePluginCreator_getTargetExtensionPoint (SBasePluginCreatorBase_t *creator)
 _tReturns_t _tthe_t _tSBaseExtensionPoint_t_t _ttied_t _tto_t _tthis_t _tcreator_t _tstructure_t.
 
const char * SBasePluginCreator_getTargetPackageName (SBasePluginCreatorBase_t *creator)
 _tReturns_t _tthe_t _ttarget_t _tpackage_t _tname_t _tof_t _tthe_t _tcreator_t _tstructure_t.
 
int SBasePluginCreator_getTargetSBMLTypeCode (SBasePluginCreatorBase_t *creator)
 _tReturns_t _tthe_t _tSBMLTypeCode_t_t _ttied_t _tto_t _tthe_t _tcreator_t _tstructure_t.
 
int SBasePluginCreator_isSupported (SBasePluginCreatorBase_t *creator, const char *uri)
 _tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tpackage_t _twith_t _tthe_t _tgiven_t _tnamespace_t _tis_t _tsupported_t.
 

Detailed Description

Definition of SBasePluginCreatorBase_t, the base class of SBasePlugin_t creator classes.

Author
Akiya Jouraku

Function Documentation

◆ SBasePluginCreator_clone()

SBasePluginCreatorBase_t * SBasePluginCreator_clone ( SBasePluginCreatorBase_t creator)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_createPlugin()

SBasePlugin_t * SBasePluginCreator_createPlugin ( SBasePluginCreatorBase_t creator,
const char *  uri,
const char *  prefix,
const XMLNamespaces_t xmlns 
)

_tCreates_t _tan_t _tSBasePlugin_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _turi_t _tand_t _tthe_t _tprefix_t _tof_t _tthe_t _ttarget_t _tpackage_t _textension_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tpackage_t _textension_t _turi_t. @_tparam_t _tprefix_t _tthe_t _tpackage_t _textension_t _tprefix_t. @_tparam_t _txmlns_t _tthe_t _tpackage_t _textension_t _tnamespaces_t.

@_treturn_t _tan_t _tSBasePlugin_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _turi_t _tand_t _tthe_t _tprefix_t _tof_t _tthe_t _ttarget_t _tpackage_t _textension_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tan_t _tinvalid_t _tcreator_t, _turi_t _tor_t _tprefix_t _twas_t _tgiven_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_free()

int SBasePluginCreator_free ( SBasePluginCreatorBase_t creator)

_tFrees_t _tthe_t _tgiven_t _tSBasePluginCreatorBase_t_t _tstructure_t

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_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 _tSBasePlugin_t_t

◆ SBasePluginCreator_getNumOfSupportedPackageURI()

unsigned int SBasePluginCreator_getNumOfSupportedPackageURI ( SBasePluginCreatorBase_t creator)

_tReturns_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackages_t _tby_t _tthe_t _tgiven_t _tcreator_t _tstructure_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tsupported_t _tpackages_t _tby_t _tthe_t _tgiven_t _tcreator_t _tstructure_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_getSupportedPackageURI()

char * SBasePluginCreator_getSupportedPackageURI ( SBasePluginCreatorBase_t creator,
unsigned int  index 
)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tpackage_t _turi_t _twith_t _tthe_t _tspecified_t _tindex_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t. @_tparam_t _tindex_t _tthe_t _tindex_t _tof_t _tthe_t _tpackage_t _turi_t _tto_t _treturn_t.

@_treturn_t _ta_t _tcopy_t _tof_t _tthe_t _tpackage_t _turi_t _twith_t _tthe_t _tspecified_t _tindex_t (_tHas_t _tto_t _tbe_t _tfreed_t _tby_t _tthe_t _tcaller_t). _tIf_t _tcreator_t _tis_t _tinvalid_t _tNULL_t _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_getTargetExtensionPoint()

const SBaseExtensionPoint_t * SBasePluginCreator_getTargetExtensionPoint ( SBasePluginCreatorBase_t creator)

_tReturns_t _tthe_t _tSBaseExtensionPoint_t_t _ttied_t _tto_t _tthis_t _tcreator_t _tstructure_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tSBaseExtensionPoint_t_t _tof_t _tthe_t _tcreator_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tif_t _tcreator_t _tis_t _tinvalid_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_getTargetPackageName()

const char * SBasePluginCreator_getTargetPackageName ( SBasePluginCreatorBase_t creator)

_tReturns_t _tthe_t _ttarget_t _tpackage_t _tname_t _tof_t _tthe_t _tcreator_t _tstructure_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t.

@_treturn_t _tthe_t _ttarget_t _tpackage_t _tname_t _tof_t _tthe_t _tcreator_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tif_t _tcreator_t _tis_t _tinvalid_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_getTargetSBMLTypeCode()

int SBasePluginCreator_getTargetSBMLTypeCode ( SBasePluginCreatorBase_t creator)

_tReturns_t _tthe_t _tSBMLTypeCode_t_t _ttied_t _tto_t _tthe_t _tcreator_t _tstructure_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tSBMLTypeCode_t_t _ttied_t _twith_t _tthe_t _tcreator_t _tstructure_t _tor_t _tLIBSBML_INVALID_OBJECT_t.

@_tmemberof_t _tSBasePlugin_t_t

◆ SBasePluginCreator_isSupported()

int SBasePluginCreator_isSupported ( SBasePluginCreatorBase_t creator,
const char *  uri 
)

_tReturns_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tpackage_t _twith_t _tthe_t _tgiven_t _tnamespace_t _tis_t _tsupported_t.

@_tparam_t _tcreator_t _tthe_t _tSBasePluginCreatorBase_t_t _tstructure_t. @_tparam_t _turi_t _tthe_t _tpackage_t _turi_t _tto_t _ttest_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tpackage_t _twith_t _tthe_t _tgiven_t _tnamespace_t _tis_t _tsupported_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBasePlugin_t_t