EventProbe

java.lang.Object
- org.palladiosimulator.probeframework.probes.Probe
- - org.palladiosimulator.probeframework.probes.EventProbe<EventSourceType>

Type Parameters:

EventSourceType - The type of the event source.

All Implemented Interfaces:

org.palladiosimulator.commons.designpatterns.IAbstractObservable<IProbeListener>, org.palladiosimulator.metricspec.metricentity.IMetricEntity

Direct Known Subclasses:

BasicEventProbe, EventProbeList
```
public abstract class EventProbe<EventSourceType>
extends Probe
```
Event probes measure as soon as an event is emitted for which they are registered. Therefore, they explicitly refer to an eventSource object. Subclasses have to realize the registration to this object by implementing the template method registerListener.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  protected EventSourceType eventSource
  The event source.
  - Fields inherited from class org.palladiosimulator.probeframework.probes.Probe
    metricEntityDelegate
- Constructor Summary
  
  Constructors
  Constructor Description
  
  EventProbe(org.palladiosimulator.metricspec.MetricDescription metricDescription, EventSourceType eventSource)
  Default constructor.
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  protected abstract void registerListener()
  Template method for registering observers to the event source.
  - Methods inherited from class org.palladiosimulator.probeframework.probes.Probe
    addObserver, getMetricDesciption, isCompatibleWith, notifyMeasurementSourceListener, removeObserver
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - eventSource
```
protected final EventSourceType eventSource
```
    The event source.
- Constructor Detail
  - EventProbe
```
public EventProbe(org.palladiosimulator.metricspec.MetricDescription metricDescription,
                  EventSourceType eventSource)
```
    Default constructor. Expects a suitable event source object (main characteristic of this type of probe).
    
    Parameters:
    
    eventSource - The event source object.
    
    metricDescription - The metric of the measurements of this probe.
- Method Detail
  - registerListener
```
protected abstract void registerListener()
```
    Template method for registering observers to the event source.