northEvaluator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "vrfplanmgr/evalSimulationObject.h"

//class MyEvaluator:
//
//Instances of MyEvaluator are used to perform the evaluation for a
//MyConditionalExpression using a MySearch.

namespace vrfAddConditionalExample
{
   class MyEvaluator : public DtEvalSimulationObject
   {
   public:

      //constructor
   MyEvaluator();

      //destructor
   virtual ~MyEvaluator();

      //copy constructor
   MyEvaluator(const MyEvaluator& orig);

      //assignment operator
   MyEvaluator& operator=(const MyEvaluator& orig);

      //clone operator
   virtual DtEvaluator* clone();

      //Evaluate this conditional expression for the entity with the given
      //entity name, in the context of the given DtSimulationServices,
      //and return the current result. The condExpr passed in must be of type 
      //MyConditionalExpression.
      //Checks to see if the entity in the MyConditionalExpression is 
      //facing north using a MySearch. If so, it returns true. The the modifier 
      //flag in MyConditionalExpression is passed to the search which optionally 
      //expands the test to return true if the entity and/or any of its 
      //subordinates are facing north.
   virtual bool evaluate(DtSimCondExpr* condExpr, 
      DtLocalObject* owner, const DtSimulationServices* simManager, const DtPlan* plan = 0) const;

   public:

      //Returns a newly created MyEvaluator.
   static DtEvaluator * creator();

   };
}