Package org.goplanit.component.event

Class PopulateNetworkEvent

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.event.EventImpl

org.goplanit.component.event.PopulateUntypedComponentEvent

org.goplanit.component.event.PopulateNetworkEvent

All Implemented Interfaces:

Comparable<IdAble>, PlanitComponentEvent, Event, IdAble

public class PopulateNetworkEvent
extends PopulateUntypedComponentEvent

A Populate network event is fired when PLANit requests for a registered listener to populate the newly created network 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 network needs to be populated

Constructor Summary

Constructors

Constructor	Description
PopulateNetworkEvent(PlanitComponentFactory<?> source, MacroscopicNetwork networkToPopulate)	Constructor

Method Summary

Modifier and Type	Method	Description
MacroscopicNetwork	getNetworkToPopulate()	collect network to populate

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 network needs to be populated

Constructor Detail

PopulateNetworkEvent

public PopulateNetworkEvent(PlanitComponentFactory<?> source,
                            MacroscopicNetwork networkToPopulate)

Constructor

Parameters:

source - of the event

networkToPopulate - network to populate

Method Detail

getNetworkToPopulate

public MacroscopicNetwork getNetworkToPopulate()

collect network to populate

Returns:

network