Package org.goplanit.component.event

Class PopulateZoningEvent

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.event.EventImpl

org.goplanit.component.event.PopulateUntypedComponentEvent

org.goplanit.component.event.PopulateZoningEvent

All Implemented Interfaces:

Comparable<IdAble>, PlanitComponentEvent, Event, IdAble

public class PopulateZoningEvent
extends PopulateUntypedComponentEvent

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

Constructor Summary

Constructors

Constructor	Description
PopulateZoningEvent(PlanitComponentFactory<?> source, Zoning zoningToPopulate, MacroscopicNetwork network)	Constructor

Method Summary

Modifier and Type	Method	Description
MacroscopicNetwork	getParentNetwork()	Collect PLANit network upon which this zoning is to be applied
Zoning	getZoningToPopulate()	Collect PLANit zoning 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 zoning needs to be populated

Constructor Detail

PopulateZoningEvent

public PopulateZoningEvent(PlanitComponentFactory<?> source,
                           Zoning zoningToPopulate,
                           MacroscopicNetwork network)

Constructor

Parameters:

source - of the event

zoningToPopulate - zoning to populate

network - used by this zoning

Method Detail

getZoningToPopulate

public Zoning getZoningToPopulate()

Collect PLANit zoning to populate

Returns:

zoning

getParentNetwork

public MacroscopicNetwork getParentNetwork()

Collect PLANit network upon which this zoning is to be applied

Returns:

network