com.thebluealliance.api.v3.models

Class SimpleMatch

java.lang.Object

com.thebluealliance.api.v3.models.SimpleMatch

Direct Known Subclasses:

Match

public class SimpleMatch
extends java.lang.Object

Shortform representation of a FIRST Robotics Competition match

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleMatch.Alliance Represents an alliance during a match

Constructor Summary

Constructors

Constructor and Description
SimpleMatch()

Method Summary

Modifier and Type	Method and Description
long	getActualTime()
SimpleMatch.Alliance	getBlueAlliance()
java.lang.String	getCompLevel()
java.lang.String	getEventKey()
java.lang.String	getKey()
int	getMatchNumber()
long	getPredictedTime()
SimpleMatch.Alliance	getRedAlliance()
int	getSetNumber()
long	getTime()
java.lang.String	getWinningAlliance()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleMatch

public SimpleMatch()

Method Detail

getMatchNumber

public int getMatchNumber()

Returns:

The match number of the match in the competition level.

getSetNumber

public int getSetNumber()

Returns:

The set number in a series of matches where more than one match is required in the match series.

getWinningAlliance

public java.lang.String getWinningAlliance()

Returns:

The color (red/blue) of the winning alliance. Will contain an empty string in the event of no winner, or a tie.

getCompLevel

public java.lang.String getCompLevel()

Returns:

The competition level the match was played at. Value is either qm, qf, sf, f, or ef

getEventKey

public java.lang.String getEventKey()

Returns:

Event key of the event the match was played at.

getKey

public java.lang.String getKey()

Returns:

TBA event key with the format yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER], where yyyy is the year, and EVENT_CODE is the event code of the event, COMP_LEVEL is (qm, ef, qf, sf, f), and MATCH_NUMBER is the match number in the competition level. A set number may append the competition level if more than one match in required per set.

getTime

public long getTime()

Returns:

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the scheduled match time, as taken from the published schedule.

getPredictedTime

public long getPredictedTime()

Returns:

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the TBA predicted match start time.

getActualTime

public long getActualTime()

Returns:

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time.

getBlueAlliance

public SimpleMatch.Alliance getBlueAlliance()

Returns:

SimpleMatch.Alliance object representing the blue alliance

getRedAlliance

public SimpleMatch.Alliance getRedAlliance()

Returns:

SimpleMatch.Alliance object representing the red alliance