Package org.palladiosimulator.probeframework.calculator

Class DefaultCalculatorProbeSets

java.lang.Object

org.palladiosimulator.probeframework.calculator.DefaultCalculatorProbeSets

public final class DefaultCalculatorProbeSets
extends Object

This class contains factory methods and identifier for the CalculatorProbeSets which are supported by the standard calculators of the probe framework. This class is by design not an enum as extensions which require a custom probe set should implement a similar ProbeSet helper class for and as part of their specific extension.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SINGULAR_PROBE	The sole probe contained in a configuration
static String	START_PROBE	The start probe of a StartStopProbeConfiguration
static String	STOP_PROBE	The stop probe of a StartStopProbeConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultCalculatorProbeSets()

Method Summary

Modifier and Type	Method	Description
static CalculatorProbeSet	createCustomProbeSet(Map<String,Probe> identifierToProbeMapping)	Returns a new custom CalculatorProbeSet containing the probes according to the provided mapping.
static CalculatorProbeSet	createSingularProbeConfiguration(Probe probe)	Returns a new CalculatorProbeSet containing only a single probe, e.g.
static CalculatorProbeSet	createStartStopProbeConfiguration(Probe startProbe, Probe stopProbe)	Returns a new CalculatorProbeSet containing a start and a stop probe, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINGULAR_PROBE

public static final String SINGULAR_PROBE

The sole probe contained in a configuration

See Also:

Constant Field Values

START_PROBE

public static final String START_PROBE

The start probe of a StartStopProbeConfiguration

See Also:

Constant Field Values

STOP_PROBE

public static final String STOP_PROBE

The stop probe of a StartStopProbeConfiguration

See Also:

Constant Field Values

Constructor Detail

DefaultCalculatorProbeSets

public DefaultCalculatorProbeSets()

Method Detail

createSingularProbeConfiguration

public static CalculatorProbeSet createSingularProbeConfiguration(Probe probe)

Returns a new CalculatorProbeSet containing only a single probe, e.g. as used by IdentityCalculator.

Parameters:

probe - the single probe

Returns:

a CalculatorProbeSet

createStartStopProbeConfiguration

public static CalculatorProbeSet createStartStopProbeConfiguration(Probe startProbe,
                                                                   Probe stopProbe)

Returns a new CalculatorProbeSet containing a start and a stop probe, e.g. as used by TimeSpanCalculator.

Parameters:

startProbe - the start probe

stopProbe - the stop probe

Returns:

a CalculatorProbeSet

createCustomProbeSet

public static CalculatorProbeSet createCustomProbeSet(Map<String,Probe> identifierToProbeMapping)

Returns a new custom CalculatorProbeSet containing the probes according to the provided mapping.

Parameters:

identifierToProbeMapping - a map of probe identifier to probe

Returns:

the CalculatorProbeSet