BasicObjectStateProbe

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<StateObjectType,V,Q>

Type Parameters:

StateObjectType - The type of the maintained state object.

V - The value type of the basic measure (as needed by the superclass).

Q - The quantity type of the basic measure (as needed by the superclass).

All Implemented Interfaces:

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

Direct Known Subclasses:

ExampleTakeCPUStateProbe, ExampleTakeCurrentTimeProbe, ExampleTakePassiveResourceStateProbe
```
public abstract class BasicObjectStateProbe<StateObjectType,V,Q extends javax.measure.quantity.Quantity>
extends BasicTriggeredProbe<V,Q>
```
This class realizes a basic triggered probe that observes an object's state, thus, additionally maintaining an observeredStateObject member variable. It leaves the implementation of the template method getBasicMeasure to its subclasses.

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

Constructor Summary

Constructors
Constructor	Description
`BasicObjectStateProbe(StateObjectType stateObject, org.palladiosimulator.metricspec.BaseMetricDescription metricDesciption)`	Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

protected StateObjectType getStateObject()
Getter method for the maintained state object.
- Methods inherited from class org.palladiosimulator.probeframework.probes.BasicTriggeredProbe
  doMeasure, getBasicMeasure
- 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
  - BasicObjectStateProbe
```
public BasicObjectStateProbe(StateObjectType stateObject,
                             org.palladiosimulator.metricspec.BaseMetricDescription metricDesciption)
```
    Default constructor.
    
    Parameters:
    
    stateObject - The state object to be maintained, e.g., a CPU state object.
    
    metricDesciption - The metric description as needed by the superclass.
    
    Throws:
    
    IllegalArgumentException - If the state object is null.
- Method Detail
  - getStateObject
```
protected StateObjectType getStateObject()
```
    Getter method for the maintained state object.
    
    Returns:
    
    The state object.