Objective Class Reference

#include <Objective.h>

Inheritance diagram for Objective:

List of all members.

Public Member Functions
	Objective ()
	default constructor Default objective is not defined
virtual	~Objective ()
	destructor
objective_t	type ()
	return the objective type
objectiveStatus_t	status ()
	return the objective status
double	reqPower ()
	return the required power needed to ensure the objective
BWTA::BaseLocation *	baseLoc ()
	return the base location associated to the objective
BWAPI::Position *	pos ()
	return the position associated to the objective
virtual void	start ()=0
	start the objective execution
virtual void	stop ()=0
	stop the objective execution
void	assignGroup (UnitGroup *group)
	assign a group to the current objective
Protected Attributes
objective_t	type_
objectiveStatus_t	status_
double	reqPower_
double	minReqPower_
BWTA::BaseLocation *	baseLoc_
BWAPI::Position *	pos_
std::list< UnitGroup * >	lGroup_

---

Constructor & Destructor Documentation

Objective::Objective

(

)

default constructor Default objective is not defined

Objective::~Objective

(

)

[virtual]

destructor

---

Member Function Documentation

void Objective::assignGroup

(

UnitGroup *

group

)

assign a group to the current objective

Parameters:

group

: the group to assign

Here is the call graph for this function:

BWTA::BaseLocation* Objective::baseLoc

(

)

[inline]

return the base location associated to the objective

Returns:

the base location associated to the objective

Here is the caller graph for this function:

BWAPI::Position* Objective::pos

(

)

[inline]

return the position associated to the objective

Returns:

the position associated to the objective

double Objective::reqPower

(

)

[inline]

return the required power needed to ensure the objective

Returns:

the required power needed to ensure the objective

Here is the caller graph for this function:

virtual void Objective::start

(

)

[pure virtual]

start the objective execution

Implemented in AttackBaseObj.

objectiveStatus_t Objective::status

(

)

[inline]

return the objective status

Returns:

the objective status

virtual void Objective::stop

(

)

[pure virtual]

stop the objective execution

Implemented in AttackBaseObj.

objective_t Objective::type

(

)

[inline]

return the objective type

Returns:

the objective type

---

Member Data Documentation

BWTA::BaseLocation* Objective::baseLoc_ [protected]

the base location associated to the objective

std::list<UnitGroup*> Objective::lGroup_ [protected]

list of the groups used to fulfill the objective

double Objective::minReqPower_ [protected]

minimal required power of the group to not abort the objective

BWAPI::Position* Objective::pos_ [protected]

the position associated to the objective

double Objective::reqPower_ [protected]

required power of the group to start the objective

objectiveStatus_t Objective::status_ [protected]

status of the objective

objective_t Objective::type_ [protected]

type of the objective

---

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

• SnippyHolloW-BroodwarBotQ-f01ab56/src/Micro/UnitManager/Objective.h
• SnippyHolloW-BroodwarBotQ-f01ab56/src/Micro/UnitManager/Objective.cpp