Implementation of SBMLDocumentPlugin, the derived class of SBasePlugin.
- Author
- Akiya Jouraku
Subclasses should override this method to get the list of expected attributes if they have their specific attributes.
This function is invoked from corresponding readAttributes() function.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure |
attributes | the ExpectedAttributes_t structure |
- Returns
- integer value indicating success/failure of the function. The possible values returned by this function are:
Creates a deep copy of the given SBMLDocumentPlugin_t structure.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure to be copied |
- Returns
- a (deep) copy of the given SBMLDocumentPlugin_t structure.
Creates a new SBMLDocumentPlugin_t structure with the given package uri, prefix and SBMLNamespaces.
- Parameters
-
uri | the package uri |
prefix | the package prefix |
sbmlns | the namespaces |
- Returns
- a new SBMLDocumentPlugin_t structure with the given package uri, prefix and SBMLNamespaces. Or null in case a NULL uri or prefix was given.
Returns the value of "required" attribute of corresponding package in the SBMLDocument element.
The value is true (1) if the package is required, or false (0) otherwise.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure |
- Returns
- the value of "required" attribute of corresponding package in the SBMLDocument element. The value is true (1) if the package is required, or false (0) otherwise. If the plugin is invalid LIBSBML_INVALID_OBJECT will be returned.
Subclasses must override this method to read values from the given XMLAttributes if they have their specific attributes.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure |
attributes | the XMLAttributes_t structure |
expectedAttributes | the ExpectedAttributes_t structure |
- Returns
- integer value indicating success/failure of the function. The possible values returned by this function are:
Sets the value of "required" attribute of corresponding package in the SBMLDocument element.
The value is true (1) if the package is required, or false (0) otherwise.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure |
required | the new value for the "required" attribute. |
- Returns
- the value of "required" attribute of corresponding package in the SBMLDocument element. The value is true (1) if the package is required, or false (0) otherwise. If the plugin is invalid LIBSBML_INVALID_OBJECT will be returned.
int SBMLDocumentPlugin_writeAttributes |
( |
SBMLDocumentPlugin_t * |
plugin, |
|
|
XMLOutputStream_t * |
stream |
|
) |
| |
Subclasses must override this method to write their XML attributes to the XMLOutputStream if they have their specific attributes.
- Parameters
-
plugin | the SBMLDocumentPlugin_t structure |
stream | the XMLOutputStream_t structure |
- Returns
- integer value indicating success/failure of the function. The possible values returned by this function are: