Inheritance diagram for libsbmlcs.ASTBasePlugin:

Detailed Description

{core}

Base class for extensions that plug into AST classes.

Public Member Functions
int	addChild (ASTBase child)

void	addExpectedAttributes (SWIGTYPE_p_ExpectedAttributes attributes, XMLInputStream stream, int type)

ASTBasePlugin	clone ()
	Creates and returns a deep copy of this ASTBasePlugin object. More...

void	connectToParent (ASTBase astbase)
	Sets the parent SBML object of this plugin object to this object and child elements (if any). More...

void	createMath (int type)

virtual void	Dispose ()

void	enablePackageInternal (string pkgURI, string pkgPrefix, bool flag)
	Enables/Disables the given package with child elements in this plugin object (if any). More...

ASTBase	getChild (long n)

string	getElementNamespace ()
	Returns the XML namespace (URI) of the package extension of this plugin object. More...

long	getLevel ()
	Returns the SBML level of the package extension of this plugin object. More...

ASTBase	getMath ()

string	getNameFromType (int type)

long	getNumChildren ()

string	getPackageName ()
	Returns the package name of this plugin object. More...

long	getPackageVersion ()
	Returns the package version of the package extension of this plugin object. More...

ASTBase	getParentASTObject ()
	Returns the parent ASTNode object to which this plugin object connected. More...

string	getPrefix ()
	Returns the prefix of the package extension of this plugin object. More...

SBMLNamespaces	getSBMLNamespaces ()

int	getTypeFromName (string name)

string	getURI ()
	Gets the URI to which this element belongs to. More...

long	getVersion ()
	Returns the SBML version of the package extension of this plugin object. More...

int	insertChild (long n, ASTBase newChild)

bool	isConstantNumber (int type)

bool	isCSymbolFunction (int type)

bool	isCSymbolNumber (int type)

bool	isFunction (int type)

bool	isFunctionNode (int type)

bool	isLogical (int type)

bool	isName (int type)

bool	isNumber (int type)

bool	isNumberNode (int type)

bool	isOperator (int type)

bool	isRelational (int type)

bool	isSetMath ()

bool	isTopLevelMathMLFunctionNodeTag (string name)

bool	isTopLevelMathMLNumberNodeTag (string name)

int	prependChild (ASTBase newChild)

bool	read (XMLInputStream stream, string reqd_prefix, XMLToken currentElement)

bool	readAttributes (XMLAttributes attributes, SWIGTYPE_p_ExpectedAttributes expectedAttributes, XMLInputStream stream, XMLToken element, int type)

int	removeChild (long n)

int	replaceChild (long n, ASTBase newChild)

bool	representsBinaryFunction (int type)

bool	representsNaryFunction (int type)

bool	representsQualifier (int type)

bool	representsUnaryFunction (int type)

int	setElementNamespace (string uri)
	Sets the XML namespace to which this element belongs to. More...

int	setPrefix (string prefix)

int	setSBMLExtension (SBMLExtension ext)

bool	stripPackage (string pkgPrefix, bool flag)

int	swapChildren (SWIGTYPE_p_ASTFunction that)

void	writeAttributes (XMLOutputStream stream, int type)

void	writeXMLNS (XMLOutputStream stream)

Protected Attributes
bool	swigCMemOwn

Member Function Documentation

int libsbmlcs.ASTBasePlugin.addChild ( ASTBase child )

void libsbmlcs.ASTBasePlugin.addExpectedAttributes	(	SWIGTYPE_p_ExpectedAttributes	attributes,
		XMLInputStream	stream,
		int	type
	)

ASTBasePlugin libsbmlcs.ASTBasePlugin.clone ( )

Creates and returns a deep copy of this ASTBasePlugin object.

Returns: a (deep) copy of this SBase object

void libsbmlcs.ASTBasePlugin.connectToParent ( ASTBase astbase )

Sets the parent SBML object of this plugin object to this object and child elements (if any).

(Creates a child-parent relationship by this plugin object)

This function is called when this object is created by the parent element. Subclasses must override this this function if they have one or more child elements. Also, ASTBasePlugin::connectToParent() must be called in the overridden function.

Parameters

sbase the SBase object to use

See also: setSBMLDocument; enablePackageInternal

void libsbmlcs.ASTBasePlugin.createMath ( int type )

virtual void libsbmlcs.ASTBasePlugin.Dispose ( )

virtual

void libsbmlcs.ASTBasePlugin.enablePackageInternal	(	string	pkgURI,
		string	pkgPrefix,
		bool	flag
	)

Enables/Disables the given package with child elements in this plugin object (if any).

(This is an internal implementation invoked from SBase::enablePackageInternal() function)

Subclasses which contain one or more SBase derived elements should override this function if elements defined in them can be extended by some other package extension.

See also: setSBMLDocument; connectToParent

ASTBase libsbmlcs.ASTBasePlugin.getChild ( long n )

string libsbmlcs.ASTBasePlugin.getElementNamespace ( )

Returns the XML namespace (URI) of the package extension of this plugin object.

Returns: the URI of the package extension of this plugin object.

long libsbmlcs.ASTBasePlugin.getLevel ( )

Returns the SBML level of the package extension of this plugin object.

Returns: the SBML level of the package extension of this plugin object.

ASTBase libsbmlcs.ASTBasePlugin.getMath ( )

string libsbmlcs.ASTBasePlugin.getNameFromType ( int type )

long libsbmlcs.ASTBasePlugin.getNumChildren ( )

string libsbmlcs.ASTBasePlugin.getPackageName ( )

Returns the package name of this plugin object.

Returns: the package name of this plugin object.

long libsbmlcs.ASTBasePlugin.getPackageVersion ( )

Returns the package version of the package extension of this plugin object.

Returns: the package version of the package extension of this plugin object.

ASTBase libsbmlcs.ASTBasePlugin.getParentASTObject ( )

Returns the parent ASTNode object to which this plugin object connected.

Returns: the parent ASTNode object to which this plugin object connected.

string libsbmlcs.ASTBasePlugin.getPrefix ( )

Returns the prefix of the package extension of this plugin object.

Returns: the prefix of the package extension of this plugin object.

SBMLNamespaces libsbmlcs.ASTBasePlugin.getSBMLNamespaces ( )

int libsbmlcs.ASTBasePlugin.getTypeFromName ( string name )

string libsbmlcs.ASTBasePlugin.getURI ( )

Gets the URI to which this element belongs to.

For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1/'

Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. if not found it will return the result of getElementNamespace

Returns: the URI this elements

See also: getPackageName; getElementNamespace; SBMLDocument::getSBMLNamespaces; getSBMLDocument

long libsbmlcs.ASTBasePlugin.getVersion ( )

Returns the SBML version of the package extension of this plugin object.

Returns: the SBML version of the package extension of this plugin object.

int libsbmlcs.ASTBasePlugin.insertChild	(	long	n,
		ASTBase	newChild
	)

bool libsbmlcs.ASTBasePlugin.isConstantNumber ( int type )

bool libsbmlcs.ASTBasePlugin.isCSymbolFunction ( int type )

bool libsbmlcs.ASTBasePlugin.isCSymbolNumber ( int type )

bool libsbmlcs.ASTBasePlugin.isFunction ( int type )

bool libsbmlcs.ASTBasePlugin.isFunctionNode ( int type )

bool libsbmlcs.ASTBasePlugin.isLogical ( int type )

bool libsbmlcs.ASTBasePlugin.isName ( int type )

bool libsbmlcs.ASTBasePlugin.isNumber ( int type )

bool libsbmlcs.ASTBasePlugin.isNumberNode ( int type )

bool libsbmlcs.ASTBasePlugin.isOperator ( int type )

bool libsbmlcs.ASTBasePlugin.isRelational ( int type )

bool libsbmlcs.ASTBasePlugin.isSetMath ( )

bool libsbmlcs.ASTBasePlugin.isTopLevelMathMLFunctionNodeTag ( string name )

bool libsbmlcs.ASTBasePlugin.isTopLevelMathMLNumberNodeTag ( string name )

int libsbmlcs.ASTBasePlugin.prependChild ( ASTBase newChild )

bool libsbmlcs.ASTBasePlugin.read	(	XMLInputStream	stream,
		string	reqd_prefix,
		XMLToken	currentElement
	)

bool libsbmlcs.ASTBasePlugin.readAttributes	(	XMLAttributes	attributes,
		SWIGTYPE_p_ExpectedAttributes	expectedAttributes,
		XMLInputStream	stream,
		XMLToken	element,
		int	type
	)

int libsbmlcs.ASTBasePlugin.removeChild ( long n )

int libsbmlcs.ASTBasePlugin.replaceChild	(	long	n,
		ASTBase	newChild
	)

bool libsbmlcs.ASTBasePlugin.representsBinaryFunction ( int type )

bool libsbmlcs.ASTBasePlugin.representsNaryFunction ( int type )

bool libsbmlcs.ASTBasePlugin.representsQualifier ( int type )

bool libsbmlcs.ASTBasePlugin.representsUnaryFunction ( int type )

int libsbmlcs.ASTBasePlugin.setElementNamespace ( string uri )

Sets the XML namespace to which this element belongs to.

For example, all elements that belong to SBML Level 3 Version 1 Core must set the namespace to 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must set the namespace to 'http://www.sbml.org/sbml/level3/version1/layout/version1/'

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

int libsbmlcs.ASTBasePlugin.setPrefix ( string prefix )

int libsbmlcs.ASTBasePlugin.setSBMLExtension ( SBMLExtension ext )

bool libsbmlcs.ASTBasePlugin.stripPackage	(	string	pkgPrefix,
		bool	flag
	)

int libsbmlcs.ASTBasePlugin.swapChildren ( SWIGTYPE_p_ASTFunction that )

void libsbmlcs.ASTBasePlugin.writeAttributes	(	XMLOutputStream	stream,
		int	type
	)

void libsbmlcs.ASTBasePlugin.writeXMLNS ( XMLOutputStream stream )

Member Data Documentation

bool libsbmlcs.ASTBasePlugin.swigCMemOwn

protected

Detailed Description

Public Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation