BreakEdgeSegmentEvent (PLANitAllJavaOnly 0.4.0 API)

java.lang.Object
- org.goplanit.utils.id.IdAbleImpl
- - org.goplanit.utils.event.EventImpl
  - - org.goplanit.graph.directed.modifier.event.BreakEdgeSegmentEvent

All Implemented Interfaces:

Comparable<IdAble>, Event, DirectedGraphModificationEvent, GraphModificationEvent, IdAble
```
public class BreakEdgeSegmentEvent
extends EventImpl
implements DirectedGraphModificationEvent
```
Wrapper around break edge segment event

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static DirectedGraphModifierEventType EVENT_TYPE
event type fired off when edge has been broken

Constructor Summary

Constructors
Constructor	Description
`BreakEdgeSegmentEvent(DirectedGraphModifier source, DirectedVertex vertexToBreakAt, EdgeSegment brokenEdgeSegment)`	constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`EdgeSegment`	`getNewlyBrokenEdgeSegment()`	Collect broken edge segment
`DirectedVertex`	`getVertexToBreakAt()`	collect vertex to break at

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 DirectedGraphModifierEventType EVENT_TYPE
```
    event type fired off when edge has been broken
- Constructor Detail
  - BreakEdgeSegmentEvent
```
public BreakEdgeSegmentEvent(DirectedGraphModifier source,
                             DirectedVertex vertexToBreakAt,
                             EdgeSegment brokenEdgeSegment)
```
    constructor
    
    Parameters:
    
    source - of the event
    
    vertexToBreakAt - vertex to break at
    
    brokenEdgeSegment - a new edge segment as a result of breaking at vertexToBreakAt
- Method Detail
  - getVertexToBreakAt
```
public DirectedVertex getVertexToBreakAt()
```
    collect vertex to break at
    
    Returns:
    
    vertex to break at
  - getNewlyBrokenEdgeSegment
```
public EdgeSegment getNewlyBrokenEdgeSegment()
```
    Collect broken edge segment
    
    Returns:
    
    edgeSegment