SPAR/AIModule/SparAIModule/DecisionMaking/Layer1Reactive/FSM/LowLevelAction.h

Go to the documentation of this file.

#pragma once
#include "../../../Common.h"
#include "../../../PersistentUnitGroup.h"
#include "IBehaviorState.h"
#include <BWAPI.h>

class ArbitratorUnitData;

class LowLevelAction
{
public:
  LowLevelAction(IBehaviorState& state)
    : m_state(state)
  {
  }

  virtual ~LowLevelAction() {}

  virtual std::string getDescription() const = 0;

  virtual bool execute(BWAPI::Unit* unit) const = 0;

  bool execute(const PersistentUnitGroup* group) const
  {
    bool result = true;
    for (PersistentUnitGroup::const_iterator it = group->begin();
         it != group->end();
         ++it)
    {
      result = execute(*it) && result;
    }
    return result;
  }

  //
  // At the moment an action is considered terminated when the issuing behavior changes state.
  // This could be implemented differently, i.e. each action keeps a list of subscribers
  // and each behavior state is responsible for terminating its actions.
  //

  typedef IBehaviorState::OnStateExit OnActionEnded;
  OnActionEnded& getActionEndedEvent() const { return m_state.getStateExitEvent(); }

protected:
  IBehaviorState& m_state;
};