ariac::GoalScore Class Reference

The score of a goal. More...

#include <ARIAC.hh>

List of all members.

Public Member Functions
bool	isComplete () const
	Calculate if the goal is complete.
double	total () const
	Calculate the total score.
Public Attributes
GoalID_t	goalID
	ID of the goal being scored.
double	timeTaken = 0.0
	Time in seconds spend on the goal.
std::map< TrayID_t, TrayScore >	trayScores
	Mapping between tray IDs and scores.
Friends
std::ostream &	operator<< (std::ostream &_out, const GoalScore &_obj)
	Stream insertion operator.

---

Detailed Description

The score of a goal.

Definition at line 68 of file ARIAC.hh.

---

Member Function Documentation

bool ariac::GoalScore::isComplete

(

)

const [inline]

Calculate if the goal is complete.

Returns:

True if all trays are complete. Will return false if there are no trays in the goal.

Definition at line 101 of file ARIAC.hh.

double ariac::GoalScore::total

(

)

const [inline]

Calculate the total score.

Definition at line 116 of file ARIAC.hh.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	_out,
		const GoalScore &	_obj
	)		[friend]

Stream insertion operator.

Parameters:

[in]	_out	output stream.
[in]	_obj	GoalScore object to output.

Returns:

The output stream

Definition at line 74 of file ARIAC.hh.

---

Member Data Documentation

GoalID_t ariac::GoalScore::goalID

ID of the goal being scored.

Definition at line 93 of file ARIAC.hh.

double ariac::GoalScore::timeTaken = 0.0

Time in seconds spend on the goal.

Definition at line 96 of file ARIAC.hh.

std::map<TrayID_t, TrayScore> ariac::GoalScore::trayScores

Mapping between tray IDs and scores.

Definition at line 90 of file ARIAC.hh.

---

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

• ARIAC.hh