LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | Static Public Attributes | List of all members
rcsc::Intercept Class Reference

intercept action data More...

#include <intercept.h>

Public Types

enum  StaminaType { NORMAL = 0 , EXHAUST = 100 }
 stamina type More...
 
enum  ActionType { OMNI_DASH = 0 , TURN_FORWARD_DASH = 1 , TURN_BACK_DASH = 2 , UNKNOWN_TYPE = 100 }
 action type
 

Public Member Functions

 Intercept ()
 create invalid info
 
 Intercept (const StaminaType stamina_type, const ActionType action_type, const int turn_step, const double turn_angle, const int dash_step, const double dash_power, const double dash_dir, const Vector2D &self_pos, const double ball_dist, const double stamina)
 construct with all variables
 
void setEvaluation (const int idx, const double value)
 set the evaluaion value with index count More...
 
bool isValid () const
 check if this object is legal one or not. More...
 
int index () const
 get the index count within candidate list More...
 
double value () const
 get the evaluation value of this intercept candidate More...
 
StaminaType staminaType () const
 get the result stamina type More...
 
ActionType actionType () const
 get the action type More...
 
int turnStep () const
 get estimated total turn steps More...
 
double turnAngle () const
 get the required first turn angle More...
 
int dashStep () const
 get estimated total dash cycles More...
 
int reachStep () const
 get esitimated total step to reach More...
 
double dashPower () const
 get dash power for the first dash More...
 
double dashDir () const
 ger the dash direction for the first dash More...
 
const Vector2DselfPos () const
 get the estimated final self position More...
 
double ballDist () const
 get the estimated final ball distance More...
 
double stamina () const
 get the estimated final self stamina value More...
 

Static Public Attributes

static const double MIN_VALUE
 

Detailed Description

intercept action data

Member Enumeration Documentation

◆ StaminaType

stamina type

Enumerator
NORMAL 

ball gettable without stamina exhaust

EXHAUST 

fastest ball gettable, but recovery may be consumed.

Member Function Documentation

◆ actionType()

ActionType rcsc::Intercept::actionType ( ) const
inline

get the action type

Returns
type id

◆ ballDist()

double rcsc::Intercept::ballDist ( ) const
inline

get the estimated final ball distance

Returns
final ball distance

◆ dashDir()

double rcsc::Intercept::dashDir ( ) const
inline

ger the dash direction for the first dash

Returns
dash direction value (relative to body)

◆ dashPower()

double rcsc::Intercept::dashPower ( ) const
inline

get dash power for the first dash

Returns
dash power value

◆ dashStep()

int rcsc::Intercept::dashStep ( ) const
inline

get estimated total dash cycles

Returns
the number of dash steps

◆ index()

int rcsc::Intercept::index ( ) const
inline

get the index count within candidate list

Returns
index count

◆ isValid()

bool rcsc::Intercept::isValid ( ) const
inline

check if this object is legal one or not.

Returns
checked result.

◆ reachStep()

int rcsc::Intercept::reachStep ( ) const
inline

get esitimated total step to reach

Returns
the number of total steps

◆ selfPos()

const Vector2D & rcsc::Intercept::selfPos ( ) const
inline

get the estimated final self position

Returns
final self position

◆ setEvaluation()

void rcsc::Intercept::setEvaluation ( const int  idx,
const double  value 
)
inline

set the evaluaion value with index count

Parameters
idxindex value
valueevaluation value

◆ stamina()

double rcsc::Intercept::stamina ( ) const
inline

get the estimated final self stamina value

Returns
final self stamina value

◆ staminaType()

StaminaType rcsc::Intercept::staminaType ( ) const
inline

get the result stamina type

Returns
stamina type id

◆ turnAngle()

double rcsc::Intercept::turnAngle ( ) const
inline

get the required first turn angle

Returns
the first turn angle in degree

◆ turnStep()

int rcsc::Intercept::turnStep ( ) const
inline

get estimated total turn steps

Returns
the number of turn steps

◆ value()

double rcsc::Intercept::value ( ) const
inline

get the evaluation value of this intercept candidate

Returns
evaluation value

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