io.github.fnss

Class EventSchedule

java.lang.Object

io.github.fnss.EventSchedule

All Implemented Interfaces:

Iterable<Event>

public class EventSchedule
extends Object
implements Iterable<Event>

Represent a schedule of events. Each event is represented by a time and a set of properties.

Author:

Lorenzo Saino

Constructor Summary

Constructors

Constructor and Description
EventSchedule(String timeUnit, float startTime, float endTime) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addEvent(Event event) Add an event to the schedule
float	getEndTime() Return the end time of the event schedule
Event	getEvent(int i) Return the i-th event of the schedule
float	getStartTime() Return the start time of the event schedule
String	getTimeUnit() Return the unit of time
Iterator<Event>	iterator() Returns an iterator over the events of the schedule.
void	removeEvent(Event event) Remove an event from the schedule
void	removeEvent(int i) Add an event to the schedule
void	setEndTime(long endTime) Set the end time of the event schedule
void	setStartTime(long startTime) Set the start time of the event schedule
void	setTimeUnit(String timeUnit) Set the unit of time
int	size() Return the number of events in the schedule

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSchedule

public EventSchedule(String timeUnit,
             float startTime,
             float endTime)

Constructor

Parameters:

timeUnit - The unit of time of the event

startTime - The start time of the schedule

endTime - The end time of the schedule

Method Detail

getTimeUnit

public String getTimeUnit()

Return the unit of time

Returns:

timeUnit the unit of time

setTimeUnit

public void setTimeUnit(String timeUnit)

Set the unit of time

Parameters:

timeUnit - the unit of time

getStartTime

public float getStartTime()

Return the start time of the event schedule

Returns:

the startTime of the event schedule

setStartTime

public void setStartTime(long startTime)

Set the start time of the event schedule

Parameters:

startTime - the start time

getEndTime

public float getEndTime()

Return the end time of the event schedule

Returns:

the endTime

setEndTime

public void setEndTime(long endTime)

Set the end time of the event schedule

Parameters:

endTime - the endTime to set

addEvent

public void addEvent(Event event)

Add an event to the schedule

Parameters:

event - The Event object to add to the schedule

removeEvent

public void removeEvent(int i)

Add an event to the schedule

Parameters:

i - The index of the Event object to remove

removeEvent

public void removeEvent(Event event)

Remove an event from the schedule

Parameters:

event - The Event object to remove

getEvent

public Event getEvent(int i)

Return the i-th event of the schedule

Parameters:

i - the index of the Event object

Returns:

the event with index i

size

public int size()

Return the number of events in the schedule

Returns:

the number of events in the schedule

iterator

public Iterator<Event> iterator()

Returns an iterator over the events of the schedule.

Specified by:

iterator in interface Iterable<Event>

Returns:

an Iterator.