io.github.robolib

Class RobotMode

java.lang.Object

io.github.robolib.RobotMode

Direct Known Subclasses:

AutonMode, DisabledMode, TeleopMode, TestMode

public abstract class RobotMode
extends java.lang.Object

The Class RobotMode.

Author:

noriah

Field Summary

Fields

Modifier and Type	Field and Description
private GameMode	m_mode The m_mode.
private java.lang.String	m_name The m_name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RobotMode() Instantiates a new robot mode.
protected	RobotMode(GameMode mode) Instantiates a new robot mode.
protected	RobotMode(GameMode mode, java.lang.String name) Instantiates a new robot mode.
protected	RobotMode(GameMode mode, java.lang.String name, boolean active) Instantiates a new robot mode.

Method Summary

Modifier and Type	Method and Description
protected void	end() The user end code for this mode.
boolean	getActive() Get if this RobotMode is the active one for its GameMode.
GameMode	getModeType() Get the mode type for this robot mode.
java.lang.String	getName() Gets the name.
protected void	init() The user initialization code for this mode.
protected void	modeEnd() GameMode Specific end code.
protected void	modeInit() GameMode Specific init code.
protected void	modeRun() GameMode Specific run code.
protected void	run() The user run code for this mode.
void	setActive() Set this RobotMode as the active robot mode for its GameMode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_mode

private final GameMode m_mode

The m_mode.

m_name

private final java.lang.String m_name

The m_name.

Constructor Detail

RobotMode

protected RobotMode()

Instantiates a new robot mode.

RobotMode

protected RobotMode(GameMode mode)

Instantiates a new robot mode.

Parameters:

mode - the mode

RobotMode

protected RobotMode(GameMode mode,
                    java.lang.String name)

Instantiates a new robot mode.

Parameters:

mode - the mode

name - the name

RobotMode

protected RobotMode(GameMode mode,
                    java.lang.String name,
                    boolean active)

Instantiates a new robot mode.

Parameters:

mode - the mode

name - the name

active - the active

Method Detail

getName

public final java.lang.String getName()

Gets the name.

Returns:

the name

getModeType

public final GameMode getModeType()

Get the mode type for this robot mode.

Returns:

GameMode type

getActive

public final boolean getActive()

Get if this RobotMode is the active one for its GameMode.

Returns:

is this the active RobotMode for its GameMode

setActive

public final void setActive()

Set this RobotMode as the active robot mode for its GameMode.

modeInit

protected void modeInit()

GameMode Specific init code. This calls the init() method when the mode changes.

init

protected void init()

The user initialization code for this mode. This is called every time the mode changes. It is called before anything in run() is run.

modeRun

protected void modeRun()

GameMode Specific run code. This calls the run() method once every period.

run

protected void run()

The user run code for this mode. This is called every period. Every time the robot runs through a loop, this is called.

modeEnd

protected void modeEnd()

GameMode Specific end code. This calls the end() method when the mode changes.

end

protected void end()

The user end code for this mode. This is called every time the mode changes. It is called before the mode changes. Overload this to write your own end method.