TorchCraftAI
A bot for machine learning research on StarCraft: Brood War
Public Member Functions | Protected Attributes | List of all members
cherrypi::ControllerTask Class Reference

Generic Task for Controller. More...

#include <controller.h>

Inherits cherrypi::Task.

Public Member Functions

 ControllerTask (UpcId upcId, std::unordered_set< Unit * > units, State *state, std::shared_ptr< Controller > controller)
 
virtual ~ControllerTask ()=default
 
virtual void update (State *state) override
 
virtual void cancel (State *state) override
 
std::shared_ptr< Controllercontroller () const
 
virtual const char * getName () const override
 A name for this task, for debugging purposes. More...
 
- Public Member Functions inherited from cherrypi::Task
 Task (UpcId upcId, std::unordered_set< Unit * > units={})
 
virtual ~Task ()
 
TaskStatus status () const
 
void setStatus (TaskStatus status)
 
bool finished () const
 
UpcId upcId () const
 UPC id in Blackboard that caused this Task to be spawned. More...
 
std::unordered_set< Unit * > const & units () const
 A set of units occupied performing this task. More...
 
void removeUnit (Unit *unit)
 
virtual std::unordered_set< Unit * > const & proxiedUnits () const
 A set of units occupied performing this task. More...
 

Protected Attributes

std::shared_ptr< Controllercontroller_
 

Additional Inherited Members

- Protected Member Functions inherited from cherrypi::Task
std::unordered_set< Unit * > & units ()
 
virtual void removeDeadOrReassignedUnits (State *state)
 Remove units that have been assigned to another task and units that have died. More...
 

Detailed Description

Generic Task for Controller.

Please see Controller for further details and a usage example.

Constructor & Destructor Documentation

cherrypi::ControllerTask::ControllerTask ( UpcId  upcId,
std::unordered_set< Unit * >  units,
State state,
std::shared_ptr< Controller controller 
)
virtual cherrypi::ControllerTask::~ControllerTask ( )
virtualdefault

Member Function Documentation

void cherrypi::ControllerTask::cancel ( State state)
overridevirtual

Reimplemented from cherrypi::Task.

std::shared_ptr< Controller > cherrypi::ControllerTask::controller ( ) const
virtual const char* cherrypi::ControllerTask::getName ( ) const
inlineoverridevirtual

A name for this task, for debugging purposes.

Reimplemented from cherrypi::Task.

void cherrypi::ControllerTask::update ( State state)
overridevirtual

Reimplemented from cherrypi::Task.

Member Data Documentation

std::shared_ptr<Controller> cherrypi::ControllerTask::controller_
protected

The documentation for this class was generated from the following files: