BasicTriggeredProbe

java.lang.Object
- org.palladiosimulator.probeframework.probes.Probe
- - org.palladiosimulator.probeframework.probes.TriggeredProbe
  - - org.palladiosimulator.probeframework.probes.BasicTriggeredProbe<V,Q>

Type Parameters:

V - The value type of the basic measure.

Q - The quantity type of the basic measure.

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicObjectStateProbe
```
public abstract class BasicTriggeredProbe<V,Q extends javax.measure.quantity.Quantity>
extends TriggeredProbe
implements org.palladiosimulator.metricspec.metricentity.IMetricEntity
```
Implements the doMeasure method by returning a BasicMeasurement, i.e., a measurement for a BaseMetricDescription. Therefore, basic triggered probes are constructed by passing an appropriate base metric description as a parameter that is used to construct basic measurements. For determining the measurement itself, basic triggered probes invoke the template method getBasicMeasure. The values of the returned measure are of type V and their quantity is given in Q.

See Also:

Measure

Field Summary
- Fields inherited from class org.palladiosimulator.probeframework.probes.Probe
  metricEntityDelegate

Constructor Summary

Constructors
Constructor Description

BasicTriggeredProbe(org.palladiosimulator.metricspec.BaseMetricDescription metricDescription)
Default constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected ProbeMeasurement`	`doMeasure(RequestContext measurementContext)`	Template method for taking the desired probe measurement in a given request context.
`protected abstract javax.measure.Measure<V,Q>`	`getBasicMeasure(RequestContext measurementContext)`	Template method for taking the desired measure in a given request context.

Methods inherited from class org.palladiosimulator.probeframework.probes.TriggeredProbe
takeMeasurement, takeMeasurement

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

Methods inherited from interface org.palladiosimulator.metricspec.metricentity.IMetricEntity
getMetricDesciption, isCompatibleWith

- Constructor Detail
  - BasicTriggeredProbe
```
public BasicTriggeredProbe(org.palladiosimulator.metricspec.BaseMetricDescription metricDescription)
```
    Default constructor. Restricts general metric descriptions to BaseMetricDescriptions (central characteristic of this type of triggered probe).
    
    Parameters:
    
    metricDescription - A BaseMetricDescription as needed by the superclass.
- Method Detail
  - doMeasure
```
protected final ProbeMeasurement doMeasure(RequestContext measurementContext)
```
    Template method for taking the desired probe measurement in a given request context.
    
    Specified by:
    
    doMeasure in class TriggeredProbe
    
    Parameters:
    
    measurementContext - The measurement context for this probe.
    
    Returns:
    
    The taken probe measurement.
  - getBasicMeasure
```
protected abstract javax.measure.Measure<V,Q> getBasicMeasure(RequestContext measurementContext)
```
    Template method for taking the desired measure in a given request context.
    
    Parameters:
    
    measurementContext - The measurement context for this probe.
    
    Returns:
    
    The taken measure.