Class ReleaseEvent

  • All Implemented Interfaces:
    Serializable, org.djutils.event.EventInterface
    Direct Known Subclasses:
    ReleaseFlowEvent

    public class ReleaseEvent
    extends CumulativeEvent
    A release event represents the arrival of a trigger event at the opposite link boundary from where it originated. Additional information with this event is to be provided by sublassing it
    Author:
    markr
    See Also:
    Serialized Form
    • Constructor Detail

      • ReleaseEvent

        protected ReleaseEvent​(org.djutils.event.EventType type,
                               TriggerEvent triggerEvent,
                               CumulativePoint cumulativePoint,
                               Serializable singleParameter)
        Constructor
        Parameters:
        type - the release event type
        triggerEvent - , the source of each release event is a trigger event
        cumulativePoint - the cumulative reference point
        singleParameter - additional parameter
    • Method Detail

      • getSourceTriggerEvent

        public TriggerEvent getSourceTriggerEvent()
        Collect the source trigger event that is the cause of this release event being scheduled
        Returns:
        source trigger event
      • getLinkBoundaryLocation

        public LinkSegmentBoundary.Location getLinkBoundaryLocation()
        collect the link boundary location of this release event, i.e., the opposite link boundary of its source trigger event
        Returns:
        link boundary location