Inheritance diagram for SBMLVisitor:

Detailed Description

Support class for operations on SBML objects.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components.

This is a class that supports the use of the Visitor Pattern to perform operations on SBML objects. The LibSBML implementation of the Visitor Pattern couples the notion of visitation with the traversal of an SBML model oject hierarchy.

This class (SBMLVisitor) does not provide stand-alone functionality; rather, it defines the interface that user visitor classes must implement. All of the individual SBML object classes have methods named accept that are used for invoking an object of class SBMLVisitor. An example of its use is in the SBML validation system, which is internally implemented using this Visitor Pattern facility.

Public Member Functions
virtual void	leave (const SBMLDocument &x)
	Interface method for using the Visitor Pattern to perform operations on SBMLDocument objects. More...

virtual void	leave (const Model &x)
	Interface method for using the Visitor Pattern to perform operations on Model objects. More...

virtual void	leave (const KineticLaw &x)
	Interface method for using the Visitor Pattern to perform operations on KineticLaw objects. More...

virtual void	leave (const Priority &x)
	Interface method for using the Visitor Pattern to perform operations on Priority objects. More...

virtual void	leave (const Reaction &x)
	Interface method for using the Visitor Pattern to perform operations on Reaction objects. More...

virtual void	leave (const SBase &x)
	Interface method for using the Visitor Pattern to perform operations on Reaction objects. More...

virtual void	leave (const ListOf &x, int type)
	Interface method for using the Visitor Pattern to perform operations on ListOf objects. More...

virtual void	visit (const SBMLDocument &x)
	Interface method for using the Visitor Pattern to perform operations on SBMLDocument objects. More...

virtual void	visit (const Model &x)
	Interface method for using the Visitor Pattern to perform operations on Model objects. More...

virtual void	visit (const KineticLaw &x)
	Interface method for using the Visitor Pattern to perform operations on KineticLaw objects. More...

virtual void	visit (const ListOf &x, int type)
	Interface method for using the Visitor Pattern to perform operations on ListOf objects. More...

virtual bool	visit (const SBase &x)
	Interface method for using the Visitor Pattern to perform operations on SBase objects. More...

virtual bool	visit (const FunctionDefinition &x)
	Interface method for using the Visitor Pattern to perform operations on FunctionDefinition objects. More...

virtual bool	visit (const UnitDefinition &x)
	Interface method for using the Visitor Pattern to perform operations on UnitDefinition objects. More...

virtual bool	visit (const Unit &x)
	Interface method for using the Visitor Pattern to perform operations on Unit objects. More...

virtual bool	visit (const CompartmentType &x)
	Interface method for using the Visitor Pattern to perform operations on CompartmentType objects. More...

virtual bool	visit (const SpeciesType &x)
	Interface method for using the Visitor Pattern to perform operations on SpeciesType objects. More...

virtual bool	visit (const Compartment &x)
	Interface method for using the Visitor Pattern to perform operations on Compartment objects. More...

virtual bool	visit (const Species &x)
	Interface method for using the Visitor Pattern to perform operations on Species objects. More...

virtual bool	visit (const Parameter &x)
	Interface method for using the Visitor Pattern to perform operations on Parameter objects. More...

virtual bool	visit (const InitialAssignment &x)
	Interface method for using the Visitor Pattern to perform operations on InitialAssignment objects. More...

virtual bool	visit (const Rule &x)
	Interface method for using the Visitor Pattern to perform operations on Rule objects. More...

virtual bool	visit (const AlgebraicRule &x)
	Interface method for using the Visitor Pattern to perform operations on AlgebraicRule objects. More...

virtual bool	visit (const AssignmentRule &x)
	Interface method for using the Visitor Pattern to perform operations on AssignmentRule objects. More...

virtual bool	visit (const RateRule &x)
	Interface method for using the Visitor Pattern to perform operations on RateRule objects. More...

virtual bool	visit (const Constraint &x)
	Interface method for using the Visitor Pattern to perform operations on Constraint objects. More...

virtual bool	visit (const Reaction &x)
	Interface method for using the Visitor Pattern to perform operations on Reaction objects. More...

virtual bool	visit (const SimpleSpeciesReference &x)
	Interface method for using the Visitor Pattern to perform operations on SimpleSpeciesReference objects. More...

virtual bool	visit (const SpeciesReference &x)
	Interface method for using the Visitor Pattern to perform operations on SpeciesReference objects. More...

virtual bool	visit (const StoichiometryMath &x)
	Interface method for using the Visitor Pattern to perform operations on StoichiometryMath objects. More...

virtual bool	visit (const ModifierSpeciesReference &x)
	Interface method for using the Visitor Pattern to perform operations on ModifierSpeciesReference objects. More...

virtual bool	visit (const Event &x)
	Interface method for using the Visitor Pattern to perform operations on Event objects. More...

virtual bool	visit (const EventAssignment &x)
	Interface method for using the Visitor Pattern to perform operations on EventAssignment objects. More...

virtual bool	visit (const Trigger &x)
	Interface method for using the Visitor Pattern to perform operations on Trigger objects. More...

virtual bool	visit (const Delay &x)
	Interface method for using the Visitor Pattern to perform operations on Delay objects. More...

virtual void	visit (const Priority &x)
	Interface method for using the Visitor Pattern to perform operations on Priority objects. More...

virtual	~SBMLVisitor ()
	Destructor method. More...

Constructor & Destructor Documentation

SBMLVisitor::~SBMLVisitor ( )

virtual

Destructor method.

Member Function Documentation

void SBMLVisitor::leave ( const SBMLDocument & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SBMLDocument objects.

Parameters

x	the SBMLDocument object to visit.

void SBMLVisitor::leave ( const Model & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Model objects.

Parameters

x	the Model object to visit.

void SBMLVisitor::leave ( const KineticLaw & x )

virtual

Interface method for using the Visitor Pattern to perform operations on KineticLaw objects.

Parameters

x	the KineticLaw object to visit.

void SBMLVisitor::leave ( const Priority & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Priority objects.

Parameters

x	the Priority object to visit.

void SBMLVisitor::leave ( const Reaction & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Reaction objects.

Parameters

x	the Reaction object to visit.

void SBMLVisitor::leave ( const SBase & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Reaction objects.

Parameters

x	the Reaction object to visit.

void SBMLVisitor::leave	(	const ListOf &	x,
		int	type
	)

virtual

Interface method for using the Visitor Pattern to perform operations on ListOf objects.

Parameters

x	the ListOf object to visit.
type	the object type code.

void SBMLVisitor::visit ( const SBMLDocument & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SBMLDocument objects.

Parameters

x	the SBMLDocument object to visit.

void SBMLVisitor::visit ( const Model & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Model objects.

Parameters

x	the Model object to visit.

void SBMLVisitor::visit ( const KineticLaw & x )

virtual

Interface method for using the Visitor Pattern to perform operations on KineticLaw objects.

Parameters

x	the KineticLaw object to visit.

void SBMLVisitor::visit	(	const ListOf &	x,
		int	type
	)

virtual

Interface method for using the Visitor Pattern to perform operations on ListOf objects.

Parameters

x	the ListOf object to visit.
type	the object type code.

bool SBMLVisitor::visit ( const SBase & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SBase objects.

Parameters

x	the SBase object to visit.

bool SBMLVisitor::visit ( const FunctionDefinition & x )

virtual

Interface method for using the Visitor Pattern to perform operations on FunctionDefinition objects.

Parameters

x	the FunctionDefinition object to visit.

bool SBMLVisitor::visit ( const UnitDefinition & x )

virtual

Interface method for using the Visitor Pattern to perform operations on UnitDefinition objects.

Parameters

x	the UnitDefinition object to visit.

bool SBMLVisitor::visit ( const Unit & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Unit objects.

Parameters

x	the Unit object to visit.

bool SBMLVisitor::visit ( const CompartmentType & x )

virtual

Interface method for using the Visitor Pattern to perform operations on CompartmentType objects.

Parameters

x	the CompartmentType object to visit.

bool SBMLVisitor::visit ( const SpeciesType & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SpeciesType objects.

Parameters

x	the SpeciesType object to visit.

bool SBMLVisitor::visit ( const Compartment & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Compartment objects.

Parameters

x	the Compartment object to visit.

bool SBMLVisitor::visit ( const Species & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Species objects.

Parameters

x	the Species object to visit.

bool SBMLVisitor::visit ( const Parameter & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Parameter objects.

Parameters

x	the Parameter object to visit.

bool SBMLVisitor::visit ( const InitialAssignment & x )

virtual

Interface method for using the Visitor Pattern to perform operations on InitialAssignment objects.

Parameters

x	the InitialAssignment object to visit.

bool SBMLVisitor::visit ( const Rule & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Rule objects.

Parameters

x	the Rule object to visit.

bool SBMLVisitor::visit ( const AlgebraicRule & x )

virtual

Interface method for using the Visitor Pattern to perform operations on AlgebraicRule objects.

Parameters

x	the AlgebraicRule object to visit.

bool SBMLVisitor::visit ( const AssignmentRule & x )

virtual

Interface method for using the Visitor Pattern to perform operations on AssignmentRule objects.

Parameters

x	the AssignmentRule object to visit.

bool SBMLVisitor::visit ( const RateRule & x )

virtual

Interface method for using the Visitor Pattern to perform operations on RateRule objects.

Parameters

x	the RateRule object to visit.

bool SBMLVisitor::visit ( const Constraint & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Constraint objects.

Parameters

x	the Constraint object to visit.

bool SBMLVisitor::visit ( const Reaction & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Reaction objects.

Parameters

x	the Reaction object to visit.

bool SBMLVisitor::visit ( const SimpleSpeciesReference & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SimpleSpeciesReference objects.

Parameters

x	the SimpleSpeciesReference object to visit.

bool SBMLVisitor::visit ( const SpeciesReference & x )

virtual

Interface method for using the Visitor Pattern to perform operations on SpeciesReference objects.

Parameters

x	the SpeciesReference object to visit.

bool SBMLVisitor::visit ( const StoichiometryMath & x )

virtual

Interface method for using the Visitor Pattern to perform operations on StoichiometryMath objects.

Parameters

x	the StoichiometryMath object to visit.

bool SBMLVisitor::visit ( const ModifierSpeciesReference & x )

virtual

Interface method for using the Visitor Pattern to perform operations on ModifierSpeciesReference objects.

Parameters

x	the ModifierSpeciesReference object to visit.

bool SBMLVisitor::visit ( const Event & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Event objects.

Parameters

x	the Event object to visit.

bool SBMLVisitor::visit ( const EventAssignment & x )

virtual

Interface method for using the Visitor Pattern to perform operations on EventAssignment objects.

Parameters

x	the EventAssignment object to visit.

bool SBMLVisitor::visit ( const Trigger & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Trigger objects.

Parameters

x	the Trigger object to visit.

bool SBMLVisitor::visit ( const Delay & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Delay objects.

Parameters

x	the Delay object to visit.

void SBMLVisitor::visit ( const Priority & x )

virtual

Interface method for using the Visitor Pattern to perform operations on Priority objects.

Parameters

x	the Priority object to visit.

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation