Package org.goplanit.assignment.ltm.eltm.event

Class ReleaseFlowEvent

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.event.EventImpl

org.goplanit.assignment.ltm.eltm.event.CumulativeEvent

org.goplanit.assignment.ltm.eltm.event.ReleaseEvent

org.goplanit.assignment.ltm.eltm.event.ReleaseFlowEvent

All Implemented Interfaces:

Cloneable, Comparable<IdAble>, Event, IdAble

public class ReleaseFlowEvent
extends ReleaseEvent

A release flow event represents a flow rate that is being released on a link boundary on the opposite border from where it was triggered through a trigger event.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static EventType	LTM_RELEASE_FLOW_EVENT	event type to identify ltm events representing a change in flow that is being released

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReleaseFlowEvent(TriggerFlowEvent sourceTriggerEvent, CumulativePoint cumulativePoint, double flowRatePcuPerHour)	Constructor

Method Summary

Modifier and Type	Method	Description
static ReleaseFlowEvent	createReleaseFlowEvent(TriggerFlowEvent sourceTriggerEvent, CumulativePoint cumulativePoint, double flowRatePcuPerHour)	Create a new release flow event being release on the opposite boundary of the source trigger
double	getPcuFowRatePerHour()

Methods inherited from class org.goplanit.assignment.ltm.eltm.event.ReleaseEvent

getLinkBoundaryLocation, getSourceTriggerEvent

Methods inherited from class org.goplanit.assignment.ltm.eltm.event.CumulativeEvent

generateEventId, getCumulativePoint, getEventContentByIndex, getId, setEventContentByIndex

Methods inherited from class org.goplanit.utils.event.EventImpl

clone, getContent, getSource, getType, toString

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, generateId, hashCode, setId

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, idEquals, idHashCode

Field Detail

LTM_RELEASE_FLOW_EVENT

public static final EventType LTM_RELEASE_FLOW_EVENT

event type to identify ltm events representing a change in flow that is being released

Constructor Detail

ReleaseFlowEvent

protected ReleaseFlowEvent(TriggerFlowEvent sourceTriggerEvent,
                           CumulativePoint cumulativePoint,
                           double flowRatePcuPerHour)

Constructor

Parameters:

sourceTriggerEvent - the source trigger this release event originated from (its source)

cumulativePoint - the cumulative reference point

flowRatePcuPerHour - the flow rate

Method Detail

createReleaseFlowEvent

public static ReleaseFlowEvent createReleaseFlowEvent(TriggerFlowEvent sourceTriggerEvent,
                                                      CumulativePoint cumulativePoint,
                                                      double flowRatePcuPerHour)

Create a new release flow event being release on the opposite boundary of the source trigger

Parameters:

sourceTriggerEvent - the source trigger this release event originated from (its source)

cumulativePoint - the cumulative reference point

flowRatePcuPerHour - the flow rate

Returns:

created release flow event

getPcuFowRatePerHour

public double getPcuFowRatePerHour()

Returns:

the pcuFowRatePerHour