genius.core.timeline

Class Timeline

java.lang.Object

genius.core.timeline.Timeline

All Implemented Interfaces:

TimeLineInfo, java.io.Serializable

Direct Known Subclasses:

ContinuousTimeline, DiscreteTimeline

public abstract class Timeline
extends java.lang.Object
implements TimeLineInfo

A time line, running from t = 0 (start) to t = 1 (deadline).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Timeline.Type In a time-based protocol, time passes within a round.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasDeadline
protected boolean	paused

Constructor Summary

Constructors

Constructor and Description
Timeline()

Method Summary

Modifier and Type	Method and Description
abstract double	getCurrentTime()
abstract double	getTime() Gets the time, running from t = 0 (start) to t = 1 (deadline).
abstract double	getTotalTime()
Timeline.Type	getType() In a time-based protocol, time passes within a round.
boolean	isDeadlineReached()
boolean	isPaused()

Methods inherited from class java.lang.Object

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

Field Detail

hasDeadline

protected boolean hasDeadline

paused

protected boolean paused

Constructor Detail

Timeline

public Timeline()

Method Detail

getTime

public abstract double getTime()

Gets the time, running from t = 0 (start) to t = 1 (deadline). The time is normalized, so agents need not be concerned with the actual internal clock.

Specified by:

getTime in interface TimeLineInfo

Returns:

current time in the interval [0, 1].

getTotalTime

public abstract double getTotalTime()

Specified by:

getTotalTime in interface TimeLineInfo

Returns:

amount of time in seconds, or amount of rounds depending on timeline type.

getCurrentTime

public abstract double getCurrentTime()

Specified by:

getCurrentTime in interface TimeLineInfo

Returns:

amount of seconds passed, or amount of rounds passed depending on the timeline type.

isDeadlineReached

public boolean isDeadlineReached()

Returns:

true if deadline is reached.

getType

public Timeline.Type getType()

Description copied from interface: TimeLineInfo

In a time-based protocol, time passes within a round. In contrast, in a rounds-based protocol time only passes when the action is presented.

Specified by:

getType in interface TimeLineInfo

Returns:

type of time: Type.Time or Type.Rounds.

isPaused

public boolean isPaused()

Returns:

true if timeline is paused.