Public Member Functions | Public Attributes | Friends | List of all members
ariac::GoalScore Class Reference

The score of a goal. More...

#include <ARIAC.hh>

Public Member Functions

bool isComplete () const
 Calculate if the goal is complete. More...
 
double total () const
 Calculate the total score. More...
 

Public Attributes

GoalID_t goalID
 ID of the goal being scored. More...
 
double timeTaken = 0.0
 Time in seconds spend on the goal. More...
 
std::map< TrayID_t, TrayScoretrayScores
 Mapping between tray IDs and scores. More...
 

Friends

std::ostream & operator<< (std::ostream &_out, const GoalScore &_obj)
 Stream insertion operator. More...
 

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]_outoutput stream.
[in]_objGoalScore 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:


osrf_gear
Author(s):
autogenerated on Wed Sep 7 2016 03:48:12