Package org.goplanit.component.event

Class PopulatePhysicalCostEvent

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.event.EventImpl

org.goplanit.component.event.PopulateUntypedComponentEvent

org.goplanit.component.event.PopulatePhysicalCostEvent

All Implemented Interfaces:

Cloneable, Comparable<IdAble>, PlanitComponentEvent, Event, IdAble

public class PopulatePhysicalCostEvent
extends PopulateUntypedComponentEvent

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

Constructor Summary

Constructors

Constructor	Description
PopulatePhysicalCostEvent(PlanitComponentFactory<?> source, AbstractPhysicalCost physicalCostToPopulate, MacroscopicNetwork network)	Constructor

Method Summary

Modifier and Type	Method	Description
MacroscopicNetwork	getParentNetwork()	the network on which to populate the physical cost
AbstractPhysicalCost	getPhysicalCostToPopulate()	Collect physical cost to populate

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

getAdditionalContent, getComponentToPopulate

Methods inherited from class org.goplanit.utils.event.EventImpl

clone, getContent, getSource, getType, toString

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, generateId, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

clone, compareTo, getId, idEquals, idHashCode

Field Detail

EVENT_TYPE

public static final PlanitComponentEventType EVENT_TYPE

event type fired off when a physical cost component needs to be populated

Constructor Detail

PopulatePhysicalCostEvent

public PopulatePhysicalCostEvent(PlanitComponentFactory<?> source,
                                 AbstractPhysicalCost physicalCostToPopulate,
                                 MacroscopicNetwork network)

Constructor

Parameters:

source - of the event

physicalCostToPopulate - network to populate

network - to apply to

Method Detail

getPhysicalCostToPopulate

public AbstractPhysicalCost getPhysicalCostToPopulate()

Collect physical cost to populate

Returns:

physical cost component

getParentNetwork

public MacroscopicNetwork getParentNetwork()

the network on which to populate the physical cost

Returns:

parent network