genius.core.session

Class Session

java.lang.Object

genius.core.session.Session

public class Session
extends java.lang.Object

Stores runtime info around a session. Mainly the rounds info. A Session consists of Rounds with in turn consists of Turn. From this session object some information about the current negotiation can be extracted. Important is the startNewRound(Round) method which is used to add a new round to the session. At this moment (05-08-2014) adding new rounds to the session is the responsibility of the SessionManager.

Author:

David Festen

Constructor Summary

Constructors

Constructor and Description
Session(Deadline deadlines, SessionsInfo info) Create a new instance of the session object.

Method Summary

Modifier and Type	Method and Description
Deadline	getDeadlines() Gets the deadline constraints
SessionsInfo	getInfo()
Action	getMostRecentAction() Get the most recently executed action.
Round	getMostRecentRound() Get the most recent round.
int	getRoundNumber() Get the current round number.
java.util.List<Round>	getRounds() Gets the rounds currently in this session.
long	getRuntimeInNanoSeconds()
double	getRuntimeInSeconds()
Timeline	getTimeline()
int	getTurnNumber() Get the current turn number within the current round.
boolean	isDeadlineReached() Check whether one of the deadlines is reached.
boolean	isFirstRound() Check whether this is the first round (round 1).
boolean	isTimerRunning()
void	removeLastRound() Removes the last (supposedly incomplete) round, if there is a last round
void	setRuntimeInNanoSeconds(long nanoSeconds)
void	setRuntimeInSeconds(double seconds)
void	setTimeline(Timeline timeline)
void	startNewRound(Round round) Add a round to this session.
void	startTimer() Updates the timestamp of this Session.
void	stopTimer() Updates the timestamp of this Session.

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session(Deadline deadlines,
               SessionsInfo info)

Create a new instance of the session object. This should normally only happen once every session. See also the class documentation of Session. This also creates a timeline that starts running the moment Session is created.

Parameters:

deadlines - Map of deadline constraints

info - the global SessionsInfo

Method Detail

getDeadlines

public Deadline getDeadlines()

Gets the deadline constraints

Returns:

a map of deadline types and values

startTimer

public void startTimer()

Updates the timestamp of this Session. Use just before starting the negotiation for most accurate timing. Timing is used in for example time deadline constraints. But might also be used in log messages as well as statistics.

stopTimer

public void stopTimer()

Updates the timestamp of this Session. Use just after finish the negotiation for most accurate timing. Timing is used in for example time deadline constraints. But might also be used in log messages as well as statistics. If you need to manually set it, consider using the setRuntimeInNanoSeconds(long) function.

getRounds

public java.util.List<Round> getRounds()

Gets the rounds currently in this session. When startNewRound(Round) is called a new round will be added. Each round already includes all its Turns, but some turns might not yet been done.

Returns:

list of rounds. Can be empty.

getMostRecentRound

public Round getMostRecentRound()

Get the most recent round.

Returns:

The last round of the getRounds() method, or null if no round has been done yet.

startNewRound

public void startNewRound(Round round)

Add a round to this session. Make sure it contains all the turns necessary to execute the rounds. Normally the new round will be created by using MultilateralProtocol.getRoundStructure(java.util.List, Session)

Parameters:

round - The round to add to this session.

getRoundNumber

public int getRoundNumber()

Get the current round number. one-based (meaning first round is round 1)

Returns:

Integer representing the round number

getTurnNumber

public int getTurnNumber()

Get the current turn number within the current round.

Returns:

current turn within the round. 0 if no actions have been done yet or if we are not even in a round.

isFirstRound

public boolean isFirstRound()

Check whether this is the first round (round 1).

Returns:

true if getRoundNumber() equals 1

removeLastRound

public void removeLastRound()

Removes the last (supposedly incomplete) round, if there is a last round

getMostRecentAction

public Action getMostRecentAction()

Get the most recently executed action.

Returns:

The most recent action of the most recent round. Null if no action has been done yet.

isDeadlineReached

public boolean isDeadlineReached()

Check whether one of the deadlines is reached.

Returns:

true iff the deadline is reached. True if the runtime/round number is bigger than the actual deadline.

getRuntimeInNanoSeconds

public long getRuntimeInNanoSeconds()

getRuntimeInSeconds

public double getRuntimeInSeconds()

setRuntimeInNanoSeconds

public void setRuntimeInNanoSeconds(long nanoSeconds)

setRuntimeInSeconds

public void setRuntimeInSeconds(double seconds)

isTimerRunning

public boolean isTimerRunning()

getTimeline

public Timeline getTimeline()

setTimeline

public void setTimeline(Timeline timeline)

getInfo

public SessionsInfo getInfo()

Returns:

SessionsInfo containing all information that is fixed for all sessions in the tournament/negotiation