Branch data     Line data    Source code

       1                 :            : /*
       2                 :            :  * AF2RuleAppVisitor.hpp
       3                 :            :  *
       4                 :            :  * An AF2RuleAppVisitor is an object that visits AF2RuleApplication
       5                 :            :  * objects produced by successful potential rule applications.  It
       6                 :            :  * is a pure virtual class that requires implementing the appropriate
       7                 :            :  * visit method.
       8                 :            :  */
       9                 :            : 
      10                 :            : #ifndef AF2RULEAPPVISITOR_HPP
      11                 :            : #define AF2RULEAPPVISITOR_HPP
      12                 :            : 
      13                 :            : // MeshKit
      14                 :            : #include "meshkit/AF2RuleApplication.hpp"
      15                 :            : 
      16                 :      10009 : class AF2RuleAppVisitor
      17                 :            : {
      18                 :            :   public:
      19                 :            : 
      20                 :            :     /**
      21                 :            :      * \brief Visit an AF2RuleApplication
      22                 :            :      *
      23                 :            :      * This pure virtual method provides an interface for an
      24                 :            :      * AF2RuleAppVisitor to examine and process AF2RuleApplication
      25                 :            :      * objects that represent ways that a rule could successfully
      26                 :            :      * be applied.  When an AF2RuleAppVisitor is passed to the
      27                 :            :      * applyRule method of an AF2Rule, each acceptable quality
      28                 :            :      * potential application of the rule will be passed to the
      29                 :            :      * AF2RuleAppVisitor as an AF2RuleApplication for processing.
      30                 :            :      *
      31                 :            :      * This method may change the state of the visitor.
      32                 :            :      *
      33                 :            :      * \param ruleApp A potential rule application of acceptable
      34                 :            :      *   quality
      35                 :            :      */
      36                 :            :     virtual void visit(AF2RuleApplication const & ruleApp) = 0;
      37                 :            : };
      38                 :            : 
      39                 :            : #endif