ExampleTakeCurrentTimeProbe

java.lang.Object
- org.palladiosimulator.probeframework.probes.Probe
- - org.palladiosimulator.probeframework.probes.TriggeredProbe
  - - org.palladiosimulator.probeframework.probes.BasicTriggeredProbe<V,Q>
    - - org.palladiosimulator.probeframework.probes.BasicObjectStateProbe<SimpleSimulationContext,Double,javax.measure.quantity.Duration>
      - org.palladiosimulator.probeframework.probes.example.ExampleTakeCurrentTimeProbe

All Implemented Interfaces:

org.palladiosimulator.commons.designpatterns.IAbstractObservable<IProbeListener>, org.palladiosimulator.metricspec.metricentity.IMetricEntity
```
public class ExampleTakeCurrentTimeProbe
extends BasicObjectStateProbe<SimpleSimulationContext,Double,javax.measure.quantity.Duration>
```
Measures a point in time metric (in SI.SECOND) by taking the current simulation time of a simulation (observed state object). This class uses SimpleSimulationContext as an example simulation state object.

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

Constructor Summary

Constructors
Constructor Description

ExampleTakeCurrentTimeProbe(SimpleSimulationContext simulationContext)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected javax.measure.Measure<Double,javax.measure.quantity.Duration>`	`getBasicMeasure(RequestContext measurementContext)`	Measures the current simulation time as requested from the simulation context (observed state object).

Methods inherited from class org.palladiosimulator.probeframework.probes.BasicObjectStateProbe
getStateObject

Methods inherited from class org.palladiosimulator.probeframework.probes.BasicTriggeredProbe
doMeasure

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
  - ExampleTakeCurrentTimeProbe
```
public ExampleTakeCurrentTimeProbe(SimpleSimulationContext simulationContext)
```
    Default constructor.
    
    Parameters:
    
    simulationContext - The observer object is a simulation state object, thus, allowing to request its current simulation time.
- Method Detail
  - getBasicMeasure
```
protected javax.measure.Measure<Double,javax.measure.quantity.Duration> getBasicMeasure(RequestContext measurementContext)
```
    Measures the current simulation time as requested from the simulation context (observed state object).
    
    Specified by:
    
    getBasicMeasure in class BasicTriggeredProbe<Double,javax.measure.quantity.Duration>
    
    Parameters:
    
    measurementContext - The measurement context for this probe.
    
    Returns:
    
    The new measure.