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

game time object More...

#include <game_time.h>

Classes

struct  Greater
 compare function More...
 
struct  Less
 compare function More...
 

Public Member Functions

 GameTime ()
 default constructor. the values are set to 0.
 
 GameTime (const long c, const long s)
 construct with the specified values. More...
 
long cycle () const
 get normal time value More...
 
long stopped () const
 get stoppage time value More...
 
const GameTimeassign (const long c, const long s)
 assign new value More...
 
const GameTimesetCycle (const long c)
 assign new normal cycle More...
 
const GameTimesetStopped (const long s)
 assign new stopped cycle More...
 
const GameTimeaddCycle (const long t)
 add to normal cycle More...
 
const GameTimeaddStopped (const long t)
 add to stopped cycle More...
 

Detailed Description

game time object

Constructor & Destructor Documentation

◆ GameTime()

rcsc::GameTime::GameTime ( const long  c,
const long  s 
)
inline

construct with the specified values.

Parameters
cnormal cycle count
sstopped cycle count

Member Function Documentation

◆ addCycle()

const GameTime & rcsc::GameTime::addCycle ( const long  t)
inline

add to normal cycle

Parameters
tadded value
Returns
const reference to itself

◆ addStopped()

const GameTime & rcsc::GameTime::addStopped ( const long  t)
inline

add to stopped cycle

Parameters
tadded value
Returns
const reference to itself

◆ assign()

const GameTime & rcsc::GameTime::assign ( const long  c,
const long  s 
)
inline

assign new value

Parameters
cnew normal cycle value
snew stopped cycle value
Returns
const reference to itself

◆ cycle()

long rcsc::GameTime::cycle ( ) const
inline

get normal time value

Returns
const reference to the normal cycle value

◆ setCycle()

const GameTime & rcsc::GameTime::setCycle ( const long  c)
inline

assign new normal cycle

Parameters
cnew normal cycle value
Returns
const reference to itself

◆ setStopped()

const GameTime & rcsc::GameTime::setStopped ( const long  s)
inline

assign new stopped cycle

Parameters
snew stopped cycle value
Returns
const reference to itself

◆ stopped()

long rcsc::GameTime::stopped ( ) const
inline

get stoppage time value

Returns
const reference to the stopped cycle value

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