libSBML C++ API  libSBML 5.8.0 C++ API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CompVisitor Class Reference
Inheritance diagram for CompVisitor:
[legend]

Detailed Description

comp Support class for performing 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 (CompVisitor) 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 CompVisitor. 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 SBase &x)
 Interface method for using the Visitor Pattern to perform operations on SBase 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 leave (const Submodel &x)
 Interface method for using the Visitor Pattern to perform operations on Submodel 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 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 Port &x)
 Interface method for using the Visitor Pattern to perform operations on Port objects. More...
 
virtual bool visit (const Deletion &x)
 Interface method for using the Visitor Pattern to perform operations on Deletion objects. More...
 
virtual bool visit (const Submodel &x)
 Interface method for using the Visitor Pattern to perform operations on Submodel objects. More...
 
virtual bool visit (const ReplacedElement &x)
 Interface method for using the Visitor Pattern to perform operations on ReplacedElement objects. More...
 
virtual bool visit (const ReplacedBy &x)
 Interface method for using the Visitor Pattern to perform operations on ReplacedBy objects. More...
 
virtual bool visit (const ModelDefinition &x)
 Interface method for using the Visitor Pattern to perform operations on ModelDefinition objects. More...
 
virtual bool visit (const ExternalModelDefinition &x)
 Interface method for using the Visitor Pattern to perform operations on ExternalModelDefinition objects. More...
 
virtual ~CompVisitor ()
 Destructor method. More...
 

Friends

class CompValidatingVisitor
 

Constructor & Destructor Documentation

CompVisitor::~CompVisitor ( )
virtual

Destructor method.

Member Function Documentation

void CompVisitor::leave ( const SBMLDocument x)
virtual

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

Parameters
xthe SBMLDocument object to visit.
void CompVisitor::leave ( const Model x)
virtual

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

Parameters
xthe Model object to visit.
void CompVisitor::leave ( const SBase x)
virtual

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

Parameters
xthe SBase object to visit.
void CompVisitor::leave ( const ListOf x,
int  type 
)
virtual

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

Parameters
xthe ListOf object to visit.
typethe object type code.
void CompVisitor::leave ( const Submodel x)
virtual

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

Parameters
xthe Submodel object to visit.
void CompVisitor::visit ( const SBMLDocument x)
virtual

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

Parameters
xthe SBMLDocument object to visit.
void CompVisitor::visit ( const Model x)
virtual

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

Parameters
xthe Model object to visit.
void CompVisitor::visit ( const ListOf x,
int  type 
)
virtual

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

Parameters
xthe ListOf object to visit.
typethe object type code.
bool CompVisitor::visit ( const SBase x)
virtual

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

Parameters
xthe SBase object to visit.
bool CompVisitor::visit ( const Port x)
virtual

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

Parameters
xthe Port object to visit.
bool CompVisitor::visit ( const Deletion x)
virtual

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

Parameters
xthe Deletion object to visit.
bool CompVisitor::visit ( const Submodel x)
virtual

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

Parameters
xthe Submodel object to visit.
bool CompVisitor::visit ( const ReplacedElement x)
virtual

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

Parameters
xthe ReplacedElement object to visit.
bool CompVisitor::visit ( const ReplacedBy x)
virtual

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

Parameters
xthe ReplacedBy object to visit.
bool CompVisitor::visit ( const ModelDefinition x)
virtual

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

Parameters
xthe ModelDefinition object to visit.
bool CompVisitor::visit ( const ExternalModelDefinition x)
virtual

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

Parameters
xthe ExternalModelDefinition object to visit.

Friends And Related Function Documentation

friend class CompValidatingVisitor
friend