The base representation of the robot being controlled More...

Public Member Functions
void	PowerOn ()
	Turn on this robot More...

void	PowerOff ()
	Turn off this robot More...

IArena	GetArena ()
	Gets the basic information about the arena this robot is in More...

void	SendSignalToArena (ArenaSignals signal)
	Sends a signal to the arena from this robot More...

IRobotSensor	GetSensor (int index)
	Gets an interface to one of the sensors on this robot More...

int	GetSensorCount< T > ()
	Gets the count of sensors of the chosen type More...

T	GetSensor< T > (int index=0)
	Gets the requested sensor More...

IRobotPropeller	GetPropeller (int index)
	Gets an interface to one of the propellers on this robot More...

IRobotThruster	GetThruster (int index)
	Gets an interface to one of the thrusters on this robot More...

IRobotWheel	GetWheel (int index)
	Gets an interface to one of the wheels on this robot More...

LEDColors	GetLEDColor (int index)
	Gets the current color emitted by the LED light at the specified index More...

void	SetLEDColor (int index, LEDColors col)
	Set the color to be emitted by an LED on the robot More...

bool	AreAnyPartsMoving ()
	Returns true if there are any moving parts (which is not allowed prior to the race starting) More...

Properties
bool	IsPoweredOn `[get]`
	Whether or not this robot is turned on More...

int	NumSensors `[get]`
	The number of sensors on this robot More...

IRobotGyroscope	Gyroscope `[get]`
	The robot's gyroscope, used for stabilization of rotation More...

int	NumPropellers `[get]`
	The number of propellers on this robot More...

int	NumThrusters `[get]`
	The number of thrusters on this robot More...

int	NumWheels `[get]`
	The number of wheels on this robot More...

int	NumLEDs `[get]`
	Gets the number of LEDs available on this robot for in-flight feedback More...

Detailed Description

The base representation of the robot being controlled

Member Function Documentation

◆ AreAnyPartsMoving()

bool IRobotExplorer.AreAnyPartsMoving ( )

Returns true if there are any moving parts (which is not allowed prior to the race starting)

Returns: True if any parts are moving

◆ GetArena()

IArena IRobotExplorer.GetArena ( )

Gets the basic information about the arena this robot is in

Returns: The arena this robot is in

◆ GetLEDColor()

LEDColors IRobotExplorer.GetLEDColor ( int index )

Gets the current color emitted by the LED light at the specified index

Parameters

index The index of the light to query

Returns: The color of the light

◆ GetPropeller()

IRobotPropeller IRobotExplorer.GetPropeller ( int index )

Gets an interface to one of the propellers on this robot

Parameters

index The index of the propeller (from 0 to [NumPropellers-1])

Returns: An interface to the requested propeller

◆ GetSensor()

IRobotSensor IRobotExplorer.GetSensor ( int index )

Gets an interface to one of the sensors on this robot

Parameters

index The index of the sensor (from 0 to [NumSensors-1])

Returns: An interface to the requested sensor

◆ GetSensor< T >()

T IRobotExplorer.GetSensor< T > ( int index = 0 )

Gets the requested sensor

Template Parameters

T	The type of the sensor

Parameters

index The index of sensors of type T

Returns: The requested sensor of type T

Type Constraints

T

:

IRobotSensor

◆ GetSensorCount< T >()

int IRobotExplorer.GetSensorCount< T > ( )

Gets the count of sensors of the chosen type

Template Parameters

T	The type of sensors to check for

Returns: The number of sensors on this robot of type T

Type Constraints

T

:

IRobotSensor

◆ GetThruster()

IRobotThruster IRobotExplorer.GetThruster ( int index )

Gets an interface to one of the thrusters on this robot

Parameters

index The index of the thruster (from 0 to [NumThrusters-1])

Returns: An interface to the requested thruster

◆ GetWheel()

IRobotWheel IRobotExplorer.GetWheel ( int index )

Gets an interface to one of the wheels on this robot

Parameters

index The index of the wheel (from 0 to [NumWheels-1])

Returns: An interface to the requested wheel

◆ PowerOff()

void IRobotExplorer.PowerOff ( )

Turn off this robot

◆ PowerOn()

void IRobotExplorer.PowerOn ( )

Turn on this robot

◆ SendSignalToArena()

void IRobotExplorer.SendSignalToArena ( ArenaSignals signal )

Sends a signal to the arena from this robot

Parameters

signal The signal to send

◆ SetLEDColor()

void IRobotExplorer.SetLEDColor	(	int	index,
		LEDColors	col
	)

Set the color to be emitted by an LED on the robot

Parameters

index	The index of the light to set
col	The color for the light to shine

Property Documentation

◆ Gyroscope

IRobotGyroscope IRobotExplorer.Gyroscope

get

The robot's gyroscope, used for stabilization of rotation

◆ IsPoweredOn

bool IRobotExplorer.IsPoweredOn

get

Whether or not this robot is turned on

◆ NumLEDs

int IRobotExplorer.NumLEDs

get

Gets the number of LEDs available on this robot for in-flight feedback

◆ NumPropellers

int IRobotExplorer.NumPropellers

get

The number of propellers on this robot

◆ NumSensors

int IRobotExplorer.NumSensors

get

The number of sensors on this robot

◆ NumThrusters

int IRobotExplorer.NumThrusters

get

The number of thrusters on this robot

◆ NumWheels

int IRobotExplorer.NumWheels

get

The number of wheels on this robot

Virtual Robot Racing League

Developer Center

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AreAnyPartsMoving()

◆ GetArena()

◆ GetLEDColor()

◆ GetPropeller()

◆ GetSensor()

◆ GetSensor< T >()

◆ GetSensorCount< T >()

◆ GetThruster()

◆ GetWheel()

◆ PowerOff()

◆ PowerOn()

◆ SendSignalToArena()

◆ SetLEDColor()

Property Documentation

◆ Gyroscope

◆ IsPoweredOn

◆ NumLEDs

◆ NumPropellers

◆ NumSensors

◆ NumThrusters

◆ NumWheels