com.google.instrumentation.stats

Class MeasurementDescriptor.MeasurementUnit

java.lang.Object

com.google.instrumentation.stats.MeasurementDescriptor.MeasurementUnit

Enclosing class:

MeasurementDescriptor

public abstract static class MeasurementDescriptor.MeasurementUnit
extends Object

MeasurementUnit lets you build compound units of the form 10^n * (A * B * ...) / (X * Y * ...), where the elements in the numerator and denominator are all BasicUnits. A MeasurementUnit must have at least one BasicUnit in its numerator.

To specify multiplication in the numerator or denominator, simply specify multiple numerator or denominator fields. For example:

- byte-seconds (i.e. bytes * seconds): numerator: BYTES numerator: SECS

- events/sec^2 (i.e. rate of change of events/sec): numerator: SCALAR denominator: SECS denominator: SECS

To specify multiples (in power of 10) of units, specify a non-zero power10 value, for example:

- MB/s (i.e. megabytes / s): power10: 6 numerator: BYTES denominator: SECS

- nanoseconds power10: -9 numerator: SECS

Method Summary

Modifier and Type	Method and Description
static MeasurementDescriptor.MeasurementUnit	create(int power10, List<MeasurementDescriptor.BasicUnit> numerators) Constructs a MeasurementDescriptor.MeasurementUnit without the optional denominators.
static MeasurementDescriptor.MeasurementUnit	create(int power10, List<MeasurementDescriptor.BasicUnit> numerators, List<MeasurementDescriptor.BasicUnit> denominators) Constructs a MeasurementDescriptor.MeasurementUnit.
abstract List<MeasurementDescriptor.BasicUnit>	getDenominators() Unit Denominators.
abstract List<MeasurementDescriptor.BasicUnit>	getNumerators() Unit Numerators.
abstract int	getPower10() Unit multiplier (i.e.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static MeasurementDescriptor.MeasurementUnit create(int power10,
                                                           List<MeasurementDescriptor.BasicUnit> numerators,
                                                           List<MeasurementDescriptor.BasicUnit> denominators)

Constructs a MeasurementDescriptor.MeasurementUnit.

create

public static MeasurementDescriptor.MeasurementUnit create(int power10,
                                                           List<MeasurementDescriptor.BasicUnit> numerators)

Constructs a MeasurementDescriptor.MeasurementUnit without the optional denominators.

getPower10

public abstract int getPower10()

Unit multiplier (i.e. 10^power10).

getNumerators

public abstract List<MeasurementDescriptor.BasicUnit> getNumerators()

Unit Numerators.

Note: The returned list is unmodifiable and attempts to update it will throw an UnsupportedOperationException.

getDenominators

public abstract List<MeasurementDescriptor.BasicUnit> getDenominators()

Unit Denominators.

Note: The returned list is unmodifiable and attempts to update it will throw an UnsupportedOperationException.