TriggerFlowEvent (PLANitAllJavaOnly 0.4.0 API)

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.TriggerEvent
      - org.goplanit.assignment.ltm.eltm.event.TriggerFlowEvent

All Implemented Interfaces:

Comparable<IdAble>, Event, IdAble
```
public class TriggerFlowEvent
extends TriggerEvent
```
A trigger flow event represents a flow rate that is being triggered exogenously, typically by a node on either side of the link segment. Hence, that the source of this event is a link segment boundary

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static EventType LTM_TRIGGER_FLOW_EVENT
event type to identify ltm events representing a change in flow that is exogenously triggered

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`TriggerFlowEvent(LinkSegmentBoundary linkSegmentBoundary, CumulativePoint cumulativePoint, double flowRatePcuPerHour)`	Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TriggerFlowEvent`	`createTriggerFlowEvent(LinkSegmentBoundary linkBoundarySource, CumulativePoint cumulativePoint, double flowRatePcuPerHour)`	Create a new trigger flow event emanating from the passing in link boundary at a given cumulative point and flow rate
`double`	`getPcuFowRatePerHour()`

Methods inherited from class org.goplanit.assignment.ltm.eltm.event.TriggerEvent
getLinkBoundary

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
deepClone, getContent, getSource, getType, shallowClone, toString

Methods inherited from class org.goplanit.utils.id.IdAbleImpl
equals, generateAndSetId, generateId, hashCode, setId

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

Methods inherited from interface org.goplanit.utils.id.IdAble
compareTo, idEquals, idHashCode

- Field Detail
  - LTM_TRIGGER_FLOW_EVENT
```
public static final EventType LTM_TRIGGER_FLOW_EVENT
```
    event type to identify ltm events representing a change in flow that is exogenously triggered
- Constructor Detail
  - TriggerFlowEvent
```
protected TriggerFlowEvent(LinkSegmentBoundary linkSegmentBoundary,
                           CumulativePoint cumulativePoint,
                           double flowRatePcuPerHour)
```
    Constructor
    
    Parameters:
    
    linkSegmentBoundary - the link segment boundary this flow emanates from
    
    cumulativePoint - the cumulative reference point
    
    flowRatePcuPerHour - the flow rate
- Method Detail
  - createTriggerFlowEvent
```
public static TriggerFlowEvent createTriggerFlowEvent(LinkSegmentBoundary linkBoundarySource,
                                                      CumulativePoint cumulativePoint,
                                                      double flowRatePcuPerHour)
```
    Create a new trigger flow event emanating from the passing in link boundary at a given cumulative point and flow rate
    
    Parameters:
    
    linkBoundarySource - link segment boundary
    
    cumulativePoint - cumulative point to use for trigger
    
    flowRatePcuPerHour - flow rate for the event
    
    Returns:
    
    created trigger flow event
  - getPcuFowRatePerHour
```
public double getPcuFowRatePerHour()
```
    Returns:
    
    the pcuFowRatePerHour