Tools/Xabsl2/Xabsl2Engine/Xabsl2BasicBehavior.h

Go to the documentation of this file.

/** 
* @file Xabsl2BasicBehavior.h
*
* Declaration class Xabsl2BasicBehavior
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*/

#ifndef __Xabsl2BasicBehavior_h_
#define __Xabsl2BasicBehavior_h_

#include "Xabsl2Tools.h"

/**
* The base class for basic behaviors that are used by the XabslEngine
*
* @author Matthias Jüngel
* @author Martin Lötzsch
*
*/
class Xabsl2BasicBehavior : public Xabsl2NamedItem
{
public:
  /** 
  * Constructor 
  * @param name The name of the basic behavior
  * @param errorHandler A reference 
  */
  Xabsl2BasicBehavior(const char* name, Xabsl2ErrorHandler& errorHandler)
    : Xabsl2NamedItem(name), errorHandler(errorHandler),
    basicBehaviorWasActiveDuringLastExecutionOfEngine(false)
  {};
  
  /** 
  * executes the basic behavior
  */
  virtual void execute() = 0;
  
  /** sets all parameter values to 0 */
  void reset() 
  { for (int i=0; i<parameters.getSize(); i++) parameters[i]=0; }
  
  /** The parameters of the basic behavior */
  Xabsl2Array<double&> parameters;

  /** Determines if the basic behavior was active during the last execution of the engine */
  bool basicBehaviorWasActiveDuringLastExecutionOfEngine;

/** 
* Registeres a reference to a parameter at the parameters array.
* @param name The name of the parameter
* @param parameter The reference to a parameter of the basic behavior
  */
  void registerParameter(const char* name, double& parameter)
  {
    XABSL2_DEBUG_INIT(errorHandler.message("registering parameter \"%s\" of basic behavior \"%s\"",name,n));
    
    if (parameters.exists(name))
    {
      errorHandler.error("registerParameter(): parameter \"%s\" was already registered",name);
      return;
    }
    parameters.append(name,parameter);
    parameter = 0;
  };
  
protected:
  /** Is invoked when a errors occur */
  Xabsl2ErrorHandler& errorHandler;
};


#endif // __Xabsl2BasicBehavior_h_

---