ReleaseFlowEvent (PLANitAllJava 0.1.0 API)

java.lang.Object
- org.djutils.event.Event
- - org.planit.ltm.event.CumulativeEvent
  - - org.planit.ltm.event.ReleaseEvent
    - - org.planit.ltm.event.ReleaseFlowEvent

All Implemented Interfaces:

Serializable, org.djutils.event.EventInterface
```
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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static org.djutils.event.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

All Methods Static Methods Instance Methods Concrete Methods
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.planit.ltm.event.ReleaseEvent
getLinkBoundaryLocation, getSourceTriggerEvent

Methods inherited from class org.planit.ltm.event.CumulativeEvent
generateEventId, getCumulativePoint, getEventContentByIndex, getId, setEventContentByIndex

Methods inherited from class org.djutils.event.Event
equals, getContent, getSourceId, getType, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LTM_RELEASE_FLOW_EVENT
```
public static final org.djutils.event.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