libsbmlcs.ASTBase Class Reference

Inheritance diagram for libsbmlcs.ASTBase:

Detailed Description

{core}

Base node for AST classes.

Public Member Functions
void	addExpectedAttributes (SWIGTYPE_p_ExpectedAttributes attributes, XMLInputStream stream)
void	addPlugin (ASTBasePlugin plugin)
ASTBase	deepCopy ()
	Creates a copy (clone). More...
virtual void	Dispose ()
string	getClass ()
int	getExtendedType ()
ASTBase	getFunction ()
string	getId ()
string	getNameFromType (int type)
long	getNumPlugins ()
	Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known. More...
string	getPackageName ()
SBase	getParentSBMLObject ()
ASTBasePlugin	getPlugin (string package)
	Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI. More...
ASTBasePlugin	getPlugin (long n)
	Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension. More...
string	getStyle ()
int	getType ()
	Get the type of this ASTNode. More...
int	getTypeCode ()
int	getTypeFromName (string name)
string	getUnitsPrefix ()
SWIGTYPE_p_void	getUserData ()
	Returns the user data that has been previously set via setUserData(). More...
bool	hasCnUnits ()
bool	hasCorrectNumberArguments ()
bool	isAvogadro ()
bool	isBinaryFunction ()
bool	isBoolean ()
bool	isChild ()
bool	isCiNumber ()
bool	isConstant ()
bool	isConstantNumber ()
bool	isCSymbolFunction ()
bool	isCSymbolNumber ()
bool	isExponential ()
bool	isFunction ()
bool	isFunctionNode ()
bool	isInteger ()
bool	isLambda ()
bool	isLogical ()
bool	isName ()
bool	isNaryFunction ()
bool	isNumber ()
bool	isNumberNode ()
bool	isOperator ()
bool	isPiecewise ()
bool	isQualifier ()
bool	isRational ()
bool	isReal ()
bool	isRelational ()
bool	isSemantics ()
bool	isSetClass ()
bool	isSetId ()
bool	isSetParentSBMLObject ()
bool	isSetStyle ()
bool	isSetType ()
bool	isSetUserData ()
bool	isTopLevelMathMLFunctionNodeTag (string name)
bool	isTopLevelMathMLNumberNodeTag (string name)
bool	isUnaryFunction ()
bool	isUnknown ()
bool	isUserFunction ()
bool	isWellFormedNode ()
void	loadASTPlugins (SBMLNamespaces sbmlns)
void	logError (XMLInputStream stream, XMLToken element, int code, string msg)
void	logError (XMLInputStream stream, XMLToken element, int code)
bool	read (XMLInputStream stream, string reqd_prefix)
bool	read (XMLInputStream stream)
bool	readAttributes (XMLAttributes attributes, SWIGTYPE_p_ExpectedAttributes expectedAttributes, XMLInputStream stream, XMLToken element)
int	setClass (string className)
int	setId (string id)
void	setIsChildFlag (bool flag)
int	setPackageName (string name)
int	setStyle (string style)
int	setType (int type)
	Sets the type of this ASTNode to the given type code. More...
int	setUserData (SWIGTYPE_p_void userData)
int	unsetClass ()
int	unsetId ()
int	unsetParentSBMLObject ()
int	unsetStyle ()
int	unsetUserData ()
void	write (XMLOutputStream stream)
void	writeNodeOfType (XMLOutputStream stream, int type, bool inChildNode)
void	writeNodeOfType (XMLOutputStream stream, int type)

Protected Attributes
bool	swigCMemOwn

Member Function Documentation

void libsbmlcs.ASTBase.addExpectedAttributes	(	SWIGTYPE_p_ExpectedAttributes	attributes,
		XMLInputStream	stream
	)

void libsbmlcs.ASTBase.addPlugin

(

ASTBasePlugin

plugin

)

ASTBase libsbmlcs.ASTBase.deepCopy

(

)

Creates a copy (clone).

virtual void libsbmlcs.ASTBase.Dispose ( )

virtual

Reimplemented in libsbmlcs.ASTNode.

string libsbmlcs.ASTBase.getClass

(

)

int libsbmlcs.ASTBase.getExtendedType

(

)

ASTBase libsbmlcs.ASTBase.getFunction

(

)

string libsbmlcs.ASTBase.getId

(

)

string libsbmlcs.ASTBase.getNameFromType

(

int

type

)

long libsbmlcs.ASTBase.getNumPlugins

(

)

Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known.

Returns

the number of plug-in objects (extension interfaces) of package extensions known by this instance of libSBML.

string libsbmlcs.ASTBase.getPackageName

(

)

SBase libsbmlcs.ASTBase.getParentSBMLObject

(

)

ASTBasePlugin libsbmlcs.ASTBase.getPlugin

(

string

package

)

Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI.

Parameters

package

the name or URI of the package

Returns

the plug-in object (the libSBML extension interface) of a package extension with the given package name or URI.

ASTBasePlugin libsbmlcs.ASTBase.getPlugin

(

long

n

)

Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension.

Parameters

n	the index of the plug-in to return

Returns

the plug-in object (the libSBML extension interface) of a package extension with the given package name or URI.

string libsbmlcs.ASTBase.getStyle

(

)

int libsbmlcs.ASTBase.getType

(

)

Get the type of this ASTNode.

The value returned is one of the enumeration values such as AST_LAMBDA, AST_PLUS, etc.

Returns

the type of this ASTNode.

int libsbmlcs.ASTBase.getTypeCode

(

)

int libsbmlcs.ASTBase.getTypeFromName

(

string

name

)

string libsbmlcs.ASTBase.getUnitsPrefix

(

)

SWIGTYPE_p_void libsbmlcs.ASTBase.getUserData

(

)

Returns the user data that has been previously set via setUserData().

Returns

the user data of this node, or null if no user data has been set.

bool libsbmlcs.ASTBase.hasCnUnits

(

)

bool libsbmlcs.ASTBase.hasCorrectNumberArguments

(

)

bool libsbmlcs.ASTBase.isAvogadro

(

)

bool libsbmlcs.ASTBase.isBinaryFunction

(

)

bool libsbmlcs.ASTBase.isBoolean

(

)

bool libsbmlcs.ASTBase.isChild

(

)

bool libsbmlcs.ASTBase.isCiNumber

(

)

bool libsbmlcs.ASTBase.isConstant

(

)

bool libsbmlcs.ASTBase.isConstantNumber

(

)

bool libsbmlcs.ASTBase.isCSymbolFunction

(

)

bool libsbmlcs.ASTBase.isCSymbolNumber

(

)

bool libsbmlcs.ASTBase.isExponential

(

)

bool libsbmlcs.ASTBase.isFunction

(

)

bool libsbmlcs.ASTBase.isFunctionNode

(

)

bool libsbmlcs.ASTBase.isInteger

(

)

bool libsbmlcs.ASTBase.isLambda

(

)

bool libsbmlcs.ASTBase.isLogical

(

)

bool libsbmlcs.ASTBase.isName

(

)

bool libsbmlcs.ASTBase.isNaryFunction

(

)

bool libsbmlcs.ASTBase.isNumber

(

)

bool libsbmlcs.ASTBase.isNumberNode

(

)

bool libsbmlcs.ASTBase.isOperator

(

)

bool libsbmlcs.ASTBase.isPiecewise

(

)

bool libsbmlcs.ASTBase.isQualifier

(

)

bool libsbmlcs.ASTBase.isRational

(

)

bool libsbmlcs.ASTBase.isReal

(

)

bool libsbmlcs.ASTBase.isRelational

(

)

bool libsbmlcs.ASTBase.isSemantics

(

)

bool libsbmlcs.ASTBase.isSetClass

(

)

bool libsbmlcs.ASTBase.isSetId

(

)

bool libsbmlcs.ASTBase.isSetParentSBMLObject

(

)

bool libsbmlcs.ASTBase.isSetStyle

(

)

bool libsbmlcs.ASTBase.isSetType

(

)

bool libsbmlcs.ASTBase.isSetUserData

(

)

bool libsbmlcs.ASTBase.isTopLevelMathMLFunctionNodeTag

(

string

name

)

bool libsbmlcs.ASTBase.isTopLevelMathMLNumberNodeTag

(

string

name

)

bool libsbmlcs.ASTBase.isUnaryFunction

(

)

bool libsbmlcs.ASTBase.isUnknown

(

)

bool libsbmlcs.ASTBase.isUserFunction

(

)

bool libsbmlcs.ASTBase.isWellFormedNode

(

)

void libsbmlcs.ASTBase.loadASTPlugins

(

SBMLNamespaces

sbmlns

)

void libsbmlcs.ASTBase.logError	(	XMLInputStream	stream,
		XMLToken	element,
		int	code,
		string	msg
	)

void libsbmlcs.ASTBase.logError	(	XMLInputStream	stream,
		XMLToken	element,
		int	code
	)

bool libsbmlcs.ASTBase.read	(	XMLInputStream	stream,
		string	reqd_prefix
	)

bool libsbmlcs.ASTBase.read

(

XMLInputStream

stream

)

bool libsbmlcs.ASTBase.readAttributes	(	XMLAttributes	attributes,
		SWIGTYPE_p_ExpectedAttributes	expectedAttributes,
		XMLInputStream	stream,
		XMLToken	element
	)

int libsbmlcs.ASTBase.setClass

(

string

className

)

int libsbmlcs.ASTBase.setId

(

string

id

)

void libsbmlcs.ASTBase.setIsChildFlag

(

bool

flag

)

int libsbmlcs.ASTBase.setPackageName

(

string

name

)

int libsbmlcs.ASTBase.setStyle

(

string

style

)

int libsbmlcs.ASTBase.setType

(

int

type

)

Sets the type of this ASTNode to the given type code.

A side-effect of doing this is that any numerical values previously stored in this node are reset to zero.

Parameters

type	the type to which this node should be set

Returns

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

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE

int libsbmlcs.ASTBase.setUserData

(

SWIGTYPE_p_void

userData

)

int libsbmlcs.ASTBase.unsetClass

(

)

int libsbmlcs.ASTBase.unsetId

(

)

int libsbmlcs.ASTBase.unsetParentSBMLObject

(

)

int libsbmlcs.ASTBase.unsetStyle

(

)

int libsbmlcs.ASTBase.unsetUserData

(

)

void libsbmlcs.ASTBase.write

(

XMLOutputStream

stream

)

void libsbmlcs.ASTBase.writeNodeOfType	(	XMLOutputStream	stream,
		int	type,
		bool	inChildNode
	)

void libsbmlcs.ASTBase.writeNodeOfType	(	XMLOutputStream	stream,
		int	type
	)

Member Data Documentation

bool libsbmlcs.ASTBase.swigCMemOwn

protected