libSBML C API
libSBML 5.20.2 C API
|
Definition of SBasePlugin_t, the base class of extension entities plugged in SBase_t derived classes in the SBML Core package. More...
Functions | |
int | SBasePlugin_addExpectedAttributes (SBasePlugin_t *plugin, ExpectedAttributes_t *attributes) |
@_tcond_t _tdoxygenLibsbmlInternal_t | |
SBasePlugin_t * | SBasePlugin_clone (SBasePlugin_t *plugin) |
_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBasePlugin_t_t _tstructure_t | |
int | SBasePlugin_connectToParent (SBasePlugin_t *plugin, SBase_t *sbase) |
_tSets_t _tthe_t _tparent_t _tSBML_t _tstructure_t _tof_t _tthis_t _tplugin_t _tstructure_t _tto_t _tthis_t _tstructure_t _tand_t _tchild_t _telements_t (_tif_t _tany_t). | |
SBase_t * | SBasePlugin_createObject (SBasePlugin_t *plugin, XMLInputStream_t *stream) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _tcreate_t, _tstore_t, _tand_t _tthen_t _treturn_t _tan_t _tSBML_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tnext_t _tXMLToken_t _tin_t _tthe_t _tXMLInputStream_t_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _telements_t. | |
int | SBasePlugin_enablePackageInternal (SBasePlugin_t *plugin, const char *pkgURI, const char *pkgPrefix, int flag) |
@_tcond_t _tdoxygenLibsbmlInternal_t | |
int | SBasePlugin_free (SBasePlugin_t *plugin) |
_tFrees_t _tthe_t _tgiven_t _tSBasePlugin_t_t _tstructure_t | |
unsigned int | SBasePlugin_getLevel (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tSBML_t _tlevel_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t. | |
const char * | SBasePlugin_getPackageName (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tpackage_t _tname_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t. | |
unsigned int | SBasePlugin_getPackageVersion (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tpackage_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t. | |
SBase_t * | SBasePlugin_getParentSBMLObject (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tto_t _twhich_t _tthis_t _tplugin_t _tstructure_t _tis_t _tconnected_t. | |
const char * | SBasePlugin_getPrefix (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tprefix_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t. | |
SBMLDocument_t * | SBasePlugin_getSBMLDocument (SBasePlugin_t *plugin) |
@_tendcond_t | |
const char * | SBasePlugin_getURI (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tXML_t _tnamespace_t (_tURI_t) _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t. | |
unsigned int | SBasePlugin_getVersion (SBasePlugin_t *plugin) |
_tReturns_t _tthe_t _tSBML_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t. | |
int | SBasePlugin_hasRequiredAttributes (SBasePlugin_t *plugin) |
_tChecks_t _tif_t _tthe_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t. | |
int | SBasePlugin_hasRequiredElements (SBasePlugin_t *plugin) |
_tChecks_t _tif_t _tthe_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _telements_t. | |
int | SBasePlugin_readAttributes (SBasePlugin_t *plugin, XMLAttributes_t *attributes, ExpectedAttributes_t *expectedAttributes) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _tread_t _tvalues_t _tfrom_t _tthe_t _tgiven_t _tXMLAttributes_t_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _tattributes_t. | |
int | SBasePlugin_readOtherXML (SBasePlugin_t *plugin, SBase_t *parentObject, XMLInputStream_t *stream) |
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tmethod_t _tto_t _tread_t (_tand_t _tstore_t) _tXHTML_t, _tMathML_t, _tetc_t. | |
int | SBasePlugin_setSBMLDocument (SBasePlugin_t *plugin, SBMLDocument_t *d) |
_tSets_t _tthe_t _tparent_t _tSBMLDocument_t _tof_t _tth_t _tplugin_t _tstructure_t. | |
int | SBasePlugin_writeAttributes (SBasePlugin_t *plugin, XMLOutputStream_t *stream) |
@_tendcond_t | |
int | SBasePlugin_writeElements (SBasePlugin_t *plugin, XMLInputStream_t *stream) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _twrite_t _tout_t _ttheir_t _tcontained_t _tSBML_t _tstructures_t _tas_t _tXML_t _telements_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _telements_t. | |
int | SBasePlugin_writeXMLNS (SBasePlugin_t *plugin, XMLOutputStream_t *stream) |
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tmethod_t _tto_t _twrite_t _trequired_t _txmlns_t _tattributes_t _tto_t _tthe_t _tXMLOutputStream_t_t (_tif_t _tany_t). | |
Definition of SBasePlugin_t, the base class of extension entities plugged in SBase_t derived classes in the SBML Core package.
int SBasePlugin_addExpectedAttributes | ( | SBasePlugin_t * | plugin, |
ExpectedAttributes_t * | attributes | ||
) |
@_tcond_t _tdoxygenLibsbmlInternal_t
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tmethod_t _tto_t _tget_t _tthe_t _tlist_t _tof_t _texpected_t _tattributes_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _tattributes_t. _tThis_t _tfunction_t _tis_t _tinvoked_t _tfrom_t _tcorresponding_t _treadAttributes_t() _tfunction_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tattributes_t _tthe_t _tExpectedAttributes_t_t _tstructure_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
SBasePlugin_t * SBasePlugin_clone | ( | SBasePlugin_t * | plugin | ) |
_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBasePlugin_t_t _tstructure_t
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tSBasePlugin_t_t _tstructure_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_connectToParent | ( | SBasePlugin_t * | plugin, |
SBase_t * | sbase | ||
) |
_tSets_t _tthe_t _tparent_t _tSBML_t _tstructure_t _tof_t _tthis_t _tplugin_t _tstructure_t _tto_t _tthis_t _tstructure_t _tand_t _tchild_t _telements_t (_tif_t _tany_t).
(_tCreates_t _ta_t _tchild_t-_tparent_t _trelationship_t _tby_t _tthis_t _tplugin_t _tstructure_t)
_tThis_t _tfunction_t _tis_t _tcalled_t _twhen_t _tthis_t _tstructure_t _tis_t _tcreated_t _tby_t _tthe_t _tparent_t _telement_t. _tSubclasses_t _tmust_t _toverride_t _tthis_t _tthis_t _tfunction_t _tif_t _tthey_t _thave_t _tone_t _tor_t _tmore_t _tchild_t _telements_t. _tAlso_t, _tSBasePlugin_connectToParent_t() _tmust_t _tbe_t _tcalled_t _tin_t _tthe_t _toverridden_t _tfunction_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tsbase_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tuse_t.
@_tsee_t _tSBasePlugin_setSBMLDocument_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
SBase_t * SBasePlugin_createObject | ( | SBasePlugin_t * | plugin, |
XMLInputStream_t * | stream | ||
) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _tcreate_t, _tstore_t, _tand_t _tthen_t _treturn_t _tan_t _tSBML_t _tstructure_t _tcorresponding_t _tto_t _tthe_t _tnext_t _tXMLToken_t _tin_t _tthe_t _tXMLInputStream_t_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _telements_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _tread_t _tfrom_t.
@_treturn_t _tthe_t _tSBML_t _tstructure_t _tcorresponding_t _tto_t _tnext_t _tXMLToken_t _tin_t _tthe_t _tXMLInputStream_t_t _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _ttoken_t _twas_t _tnot_t _trecognized_t _tor_t _tplugin_t _tor_t _tstream_t _twere_t _tNULL_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_enablePackageInternal | ( | SBasePlugin_t * | plugin, |
const char * | pkgURI, | ||
const char * | pkgPrefix, | ||
int | flag | ||
) |
@_tcond_t _tdoxygenLibsbmlInternal_t
_tEnables_t/_tDisables_t _tthe_t _tgiven_t _tpackage_t _twith_t _tchild_t _telements_t _tin_t _tthis_t _tplugin_t _tstructure_t (_tif_t _tany_t).
_tSubclasses_t _twhich_t _tcontain_t _tone_t _tor_t _tmore_t _tSBase_t _tderived_t _telements_t _tshould_t _toverride_t _tthis_t _tfunction_t _tif_t _telements_t _tdefined_t _tin_t _tthem_t _tcan_t _tbe_t _textended_t _tby_t _tsome_t _tother_t _tpackage_t _textension_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tpkgURI_t _tthe_t _tpackage_t _turi_t. @_tparam_t _tpkgPrefix_t _tthe_t _tpackage_t _tprefix_t. @_tparam_t _tflag_t _tindicating_t _twhether_t _tthe_t _tpackage_t _tshould_t _tbe_t _tenabled_t (_t1_t) _tor_t _tdisabled_t(_t0_t).
@_tsee_t _tSBasePlugin_setSBMLDocument_t @_tsee_t _tSBasePlugin_connectToParent_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
int SBasePlugin_free | ( | SBasePlugin_t * | plugin | ) |
_tFrees_t _tthe_t _tgiven_t _tSBasePlugin_t_t _tstructure_t
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_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
unsigned int SBasePlugin_getLevel | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tSBML_t _tlevel_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t _tthe_t _tSBML_t _tlevel_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t _tor_t _tSBML_INT_MAX_t _tif_t _tthe_t _tstructure_t _tis_t _tinvalid_t.
@_tmemberof_t _tSBasePlugin_t_t
const char * SBasePlugin_getPackageName | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tpackage_t _tname_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tplugin_t _tstructure_t.
@_treturn_t _tthe_t _tpackage_t _tname_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tan_t _tinvalid_t _tplugin_t _tstructure_t _tis_t _tprovided_t.
@_tmemberof_t _tSBasePlugin_t_t
unsigned int SBasePlugin_getPackageVersion | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tpackage_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t _tthe_t _tpackage_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t _tor_t _tSBML_INT_MAX_t _tif_t _tthe_t _tstructure_t _tis_t _tinvalid_t.
@_tmemberof_t _tSBasePlugin_t_t
SBase_t * SBasePlugin_getParentSBMLObject | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tto_t _twhich_t _tthis_t _tplugin_t _tstructure_t _tis_t _tconnected_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tto_t _twhich_t _tthis_t _tplugin_t _tstructure_t _tis_t _tconnected_t _tor_t @_tc_t _tNULL_t _tif_t _tsbase_t _tstructure_t _tis_t _tset_t, _tor_t _tthe_t _tplugin_t _tstructure_t _tis_t _tinvalid_t.
@_tmemberof_t _tSBasePlugin_t_t
const char * SBasePlugin_getPrefix | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tprefix_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tplugin_t _tstructure_t.
@_treturn_t _tthe_t _tprefix_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tan_t _tinvalid_t _tplugin_t _tstructure_t _tis_t _tprovided_t.
@_tmemberof_t _tSBasePlugin_t_t
SBMLDocument_t * SBasePlugin_getSBMLDocument | ( | SBasePlugin_t * | plugin | ) |
@_tendcond_t
_tReturns_t _tthe_t _tparent_t _tSBMLDocument_t _tof_t _tthis_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t _tthe_t _tparent_t _tSBMLDocument_t_t _tstructure_t _tof_t _tthis_t _tplugin_t _tstructure_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tdocument_t _tis_t _tset_t, _tor_t _tthe_t _tplugin_t _tstructure_t _tis_t _tinvalid_t.
@_tmemberof_t _tSBasePlugin_t_t
const char * SBasePlugin_getURI | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tXML_t _tnamespace_t (_tURI_t) _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthe_t _tgiven_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tplugin_t _tstructure_t.
@_treturn_t _tthe_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tin_t _tcase_t _tan_t _tinvalid_t _tplugin_t _tstructure_t _tis_t _tprovided_t.
@_tmemberof_t _tSBasePlugin_t_t
unsigned int SBasePlugin_getVersion | ( | SBasePlugin_t * | plugin | ) |
_tReturns_t _tthe_t _tSBML_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t _tthe_t _tSBML_t _tversion_t _tof_t _tthe_t _tpackage_t _textension_t _tof_t _tthis_t _tplugin_t _tstructure_t _tor_t _tSBML_INT_MAX_t _tif_t _tthe_t _tstructure_t _tis_t _tinvalid_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_hasRequiredAttributes | ( | SBasePlugin_t * | plugin | ) |
_tChecks_t _tif_t _tthe_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t.
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tfunction_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _tattributes_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _tattributes_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t. _tIf_t _tan_t _tinvalid_t _tplugin_t _twas_t _tprovided_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tis_t _treturned_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_hasRequiredElements | ( | SBasePlugin_t * | plugin | ) |
_tChecks_t _tif_t _tthe_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _telements_t.
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tfunction_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _telements_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tplugin_t _tstructure_t _thas_t _tall_t _tthe_t _trequired_t _telements_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _twill_t _tbe_t _treturned_t. _tIf_t _tan_t _tinvalid_t _tplugin_t _twas_t _tprovided_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tis_t _treturned_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_readAttributes | ( | SBasePlugin_t * | plugin, |
XMLAttributes_t * | attributes, | ||
ExpectedAttributes_t * | expectedAttributes | ||
) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _tread_t _tvalues_t _tfrom_t _tthe_t _tgiven_t _tXMLAttributes_t_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _tattributes_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tattributes_t _tthe_t _tXMLAttributes_t_t _tstructure_t. @_tparam_t _texpectedAttributes_t _tthe_t _tExpectedAttributes_t_t _tstructure_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
int SBasePlugin_readOtherXML | ( | SBasePlugin_t * | plugin, |
SBase_t * | parentObject, | ||
XMLInputStream_t * | stream | ||
) |
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tmethod_t _tto_t _tread_t (_tand_t _tstore_t) _tXHTML_t, _tMathML_t, _tetc_t.
_tdirectly_t _tfrom_t _tthe_t _tXMLInputStream_t_t _tif_t _tthe_t _ttarget_t _telements_t _tcan_t'_tt_t _tbe_t _tparsed_t _tby_t _tSBase_t::_treadAnnotation_t() _tand_t/_tor_t _tSBase_readNotes_t() _tfunctions_t
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tparentObject_t _tthe_t _tSBase_t_t _tstructure_t _tthat_t _twill_t _tstore_t _tthe_t _tannotation_t. @_tparam_t _tstream_t _tthe_t _tXMLInputStream_t_t _tstructure_t _tto_t _tread_t _tfrom_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tsubclass_t _tread_t _tfrom_t _tthe_t _tstream_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. _tIf_t _tan_t _tinvalid_t _tplugin_t _tor_t _tstream_t _twas_t _tprovided_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tis_t _treturned_t.
@_tmemberof_t _tSBasePlugin_t_t
int SBasePlugin_setSBMLDocument | ( | SBasePlugin_t * | plugin, |
SBMLDocument_t * | d | ||
) |
_tSets_t _tthe_t _tparent_t _tSBMLDocument_t _tof_t _tth_t _tplugin_t _tstructure_t.
_tSubclasses_t _twhich_t _tcontain_t _tone_t _tor_t _tmore_t _tSBase_t _tderived_t _telements_t _tmust_t _toverride_t _tthis_t _tfunction_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tto_t _tuse_t.
@_tsee_t _tSBasePlugin_connectToParent_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
int SBasePlugin_writeAttributes | ( | SBasePlugin_t * | plugin, |
XMLOutputStream_t * | stream | ||
) |
@_tendcond_t
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _twrite_t _ttheir_t _tXML_t _tattributes_t _tto_t _tthe_t _tXMLOutputStream_t_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _tattributes_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tstream_t _tthe_t _tXMLOutputStream_t_t _tstructure_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
int SBasePlugin_writeElements | ( | SBasePlugin_t * | plugin, |
XMLInputStream_t * | stream | ||
) |
_tSubclasses_t _tmust_t _toverride_t _tthis_t _tmethod_t _tto_t _twrite_t _tout_t _ttheir_t _tcontained_t _tSBML_t _tstructures_t _tas_t _tXML_t _telements_t _tif_t _tthey_t _thave_t _ttheir_t _tspecific_t _telements_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tstream_t _tthe_t _tXMLOutputStream_t_t _tstructure_t _tto_t _twrite_t _tto_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
int SBasePlugin_writeXMLNS | ( | SBasePlugin_t * | plugin, |
XMLOutputStream_t * | stream | ||
) |
_tSubclasses_t _tshould_t _toverride_t _tthis_t _tmethod_t _tto_t _twrite_t _trequired_t _txmlns_t _tattributes_t _tto_t _tthe_t _tXMLOutputStream_t_t (_tif_t _tany_t).
_tThe_t _txmlns_t _tattribute_t _twill_t _tbe_t _twritten_t _tin_t _tthe_t _telement_t _tto_t _twhich_t _tthe_t _tstructure_t _tis_t _tconnected_t. _tFor_t _texample_t, _txmlns_t _tattributes_t _twritten_t _tby_t _tthis_t _tfunction_t _twill_t _tbe_t _tadded_t _tto_t _tModel_t_t _telement_t _tif_t _tthis_t _tplugin_t _tstructure_t _tconnected_t _tto_t _tthe_t _tModel_t_t _telement_t.
@_tparam_t _tplugin_t _tthe_t _tSBasePlugin_t_t _tstructure_t. @_tparam_t _tstream_t _tthe_t _tXMLOutputStream_t_t _tstructure_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