Package org.goplanit.component.event

Class PopulateFundamentalDiagramEvent

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.event.EventImpl

org.goplanit.component.event.PopulateUntypedComponentEvent

org.goplanit.component.event.PopulateFundamentalDiagramEvent

All Implemented Interfaces:

Comparable<IdAble>, PlanitComponentEvent, Event, IdAble

public class PopulateFundamentalDiagramEvent
extends PopulateUntypedComponentEvent

A Populate fundamental diagram component event is fired when PLANit requests for a registered listener to populate the newly created fundamental diagram component instance. It is assumed only a single listener will populate this component and it is expected that the registration of this listener is handled by the platform rather than the user. The end user will - via the listener - receive this event when implementing an input builder and registering this builder on a PLANit project for example.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static PlanitComponentEventType	EVENT_TYPE	event type fired off when fundamental diagram component needs to be populated

Constructor Summary

Constructors

Constructor	Description
PopulateFundamentalDiagramEvent(PlanitComponentFactory<?> source, FundamentalDiagramComponent fdComponentToPopulate, MacroscopicNetworkLayer parentNetworkLayer)	Constructor

Method Summary

Modifier and Type	Method	Description
FundamentalDiagramComponent	getFundamentalDiagramToPopulate()	collect fundamental diagram component to populate
MacroscopicNetworkLayer	getParentNetworkLayer()	Collect PLANit network layer upon which these fundamental diagrams are to be applied

Methods inherited from class org.goplanit.component.event.PopulateUntypedComponentEvent

getAdditionalContent, getComponentToPopulate, hasAdditionalContent

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, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.event.Event

getSource, getType

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

compareTo, deepClone, getId, idEquals, idHashCode, shallowClone

Field Detail

EVENT_TYPE

public static final PlanitComponentEventType EVENT_TYPE

event type fired off when fundamental diagram component needs to be populated

Constructor Detail

PopulateFundamentalDiagramEvent

public PopulateFundamentalDiagramEvent(PlanitComponentFactory<?> source,
                                       FundamentalDiagramComponent fdComponentToPopulate,
                                       MacroscopicNetworkLayer parentNetworkLayer)

Constructor

Parameters:

source - of the event

fdComponentToPopulate - fundamental diagram component to populate

parentNetworkLayer - to use

Method Detail

getFundamentalDiagramToPopulate

public FundamentalDiagramComponent getFundamentalDiagramToPopulate()

collect fundamental diagram component to populate

Returns:

fundamental diagram component

getParentNetworkLayer

public MacroscopicNetworkLayer getParentNetworkLayer()

Collect PLANit network layer upon which these fundamental diagrams are to be applied

Returns:

network layer