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

Implementation of SBMLDocumentPlugin_t, the derived class of SBasePlugin_t. More...

Include dependency graph for SBMLDocumentPlugin.cpp:

Functions

int SBMLDocumentPlugin_addExpectedAttributes (SBMLDocumentPlugin_t *plugin, ExpectedAttributes_t *attributes)
 @_tcond_t _tdoxygenLibsbmlInternal_t
 
SBMLDocumentPlugin_tSBMLDocumentPlugin_clone (SBMLDocumentPlugin_t *plugin)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t
 
SBMLDocumentPlugin_tSBMLDocumentPlugin_create (const char *uri, const char *prefix, SBMLNamespaces_t *sbmlns)
 @_tcond_t _tdoxygenIgnored_t
 
int SBMLDocumentPlugin_free (SBMLDocumentPlugin_t *plugin)
 _tFrees_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t
 
int SBMLDocumentPlugin_getRequired (SBMLDocumentPlugin_t *plugin)
 _tReturns_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t.
 
int SBMLDocumentPlugin_isSetRequired (SBMLDocumentPlugin_t *plugin)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t'_ts_t "_trequired_t" _tattribute_t _tis_t _tset_t.
 
int SBMLDocumentPlugin_readAttributes (SBMLDocumentPlugin_t *plugin, const XMLAttributes_t *attributes, const 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 SBMLDocumentPlugin_setRequired (SBMLDocumentPlugin_t *plugin, int required)
 _tSets_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t.
 
int SBMLDocumentPlugin_unsetRequired (SBMLDocumentPlugin_t *plugin)
 _tUnsets_t _tthe_t "_trequired_t" _tattribute_t _tof_t _tthis_t _tSBMLDocumentPlugin_t_t _tstructure_t.
 
int SBMLDocumentPlugin_writeAttributes (SBMLDocumentPlugin_t *plugin, XMLOutputStream_t *stream)
 @_tendcond_t
 

Detailed Description

Implementation of SBMLDocumentPlugin_t, the derived class of SBasePlugin_t.

Author
Akiya Jouraku

Function Documentation

◆ SBMLDocumentPlugin_addExpectedAttributes()

int SBMLDocumentPlugin_addExpectedAttributes ( SBMLDocumentPlugin_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 _tSBMLDocumentPlugin_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 _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_clone()

SBMLDocumentPlugin_t * SBMLDocumentPlugin_clone ( SBMLDocumentPlugin_t plugin)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_create()

SBMLDocumentPlugin_t * SBMLDocumentPlugin_create ( const char *  uri,
const char *  prefix,
SBMLNamespaces_t sbmlns 
)

@_tcond_t _tdoxygenIgnored_t

_tCreates_t _ta_t _tnew_t _tSBMLDocumentPlugin_t_t _tstructure_t _twith_t _tthe_t _tgiven_t _tpackage_t _turi_t, _tprefix_t _tand_t _tSBMLNamespaces_t.

◆ SBMLDocumentPlugin_free()

int SBMLDocumentPlugin_free ( SBMLDocumentPlugin_t plugin)

_tFrees_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_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 _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_getRequired()

int SBMLDocumentPlugin_getRequired ( SBMLDocumentPlugin_t plugin)

_tReturns_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t.

_tThe_t _tvalue_t _tis_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _trequired_t, _tor_t @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t. _tThe_t _tvalue_t _tis_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _trequired_t, _tor_t @_tc_t _t0_t (_tfalse_t) _totherwise_t. _tIf_t _tthe_t _tplugin_t _tis_t _tinvalid_t _tLIBSBML_INVALID_OBJECT_t _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_isSetRequired()

int SBMLDocumentPlugin_isSetRequired ( SBMLDocumentPlugin_t plugin)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t'_ts_t "_trequired_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_trequired_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBMLDocumentPlugin_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_readAttributes()

int SBMLDocumentPlugin_readAttributes ( SBMLDocumentPlugin_t plugin,
const XMLAttributes_t attributes,
const 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 _tSBMLDocumentPlugin_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 _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_setRequired()

int SBMLDocumentPlugin_setRequired ( SBMLDocumentPlugin_t plugin,
int  required 
)

_tSets_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t.

_tThe_t _tvalue_t _tis_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _trequired_t, _tor_t @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_t_t _tstructure_t. @_tparam_t _trequired_t _tthe_t _tnew_t _tvalue_t _tfor_t _tthe_t "_trequired_t" _tattribute_t.

@_treturn_t _tthe_t _tvalue_t _tof_t "_trequired_t" _tattribute_t _tof_t _tcorresponding_t _tpackage_t _tin_t _tthe_t _tSBMLDocument_t_t _telement_t. _tThe_t _tvalue_t _tis_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _trequired_t, _tor_t @_tc_t _t0_t (_tfalse_t) _totherwise_t. _tIf_t _tthe_t _tplugin_t _tis_t _tinvalid_t _tLIBSBML_INVALID_OBJECT_t _twill_t _tbe_t _treturned_t.

@_tmemberof_t _tSBMLDocumentPlugin_t_t

Examples
spec_example1.c.

◆ SBMLDocumentPlugin_unsetRequired()

int SBMLDocumentPlugin_unsetRequired ( SBMLDocumentPlugin_t plugin)

_tUnsets_t _tthe_t "_trequired_t" _tattribute_t _tof_t _tthis_t _tSBMLDocumentPlugin_t_t _tstructure_t.

@_tparam_t _tplugin_t _tthe_t _tSBMLDocumentPlugin_t_t _tstructure_t _twhose_t "_trequired_t" _tattribute_t _tis_t _tto_t _tbe_t _tunset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBMLDocumentPlugin_t_t

◆ SBMLDocumentPlugin_writeAttributes()

int SBMLDocumentPlugin_writeAttributes ( SBMLDocumentPlugin_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 _tSBMLDocumentPlugin_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 _tSBMLDocumentPlugin_t_t