org.jmisb.api.klv.st1108.st1108_3.metric

Class MetricParameters

java.lang.Object

org.jmisb.api.klv.st1108.st1108_3.metric.MetricParameters

All Implemented Interfaces:

IKlvValue, IMetricLocalSetValue

public class MetricParameters
extends Object
implements IMetricLocalSetValue

Metric Parameters.

From ST 1108.3:

Metric Parameters optional item is a user-defined string for specifying any unique conditions used in the computation. For example, within the period of calculation are all Frames used and averaged, are several Frames skipped, etc. This information ensures repeatable calculations, or the same process applied downstream for like-metric comparisons.

Constructor Summary

Constructors

Constructor and Description
MetricParameters(byte[] bytes) Create from encoded bytes.
MetricParameters(String metricParameters) Create from value.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get the encoded bytes.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
String	getParameters() Get the parameters of this metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricParameters

public MetricParameters(String metricParameters)

Create from value.

Parameters:

metricParameters - the parameters for the metric calculation process.

MetricParameters

public MetricParameters(byte[] bytes)

Create from encoded bytes.

Parameters:

bytes - Byte array of the metric parameters encoded in UTF-8.

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: IMetricLocalSetValue

Get the encoded bytes.

Specified by:

getBytes in interface IMetricLocalSetValue

Returns:

The encoded byte array

getDisplayableValue

public String getDisplayableValue()

Description copied from interface: IKlvValue

Return a string of the displayable value.

Specified by:

getDisplayableValue in interface IKlvValue

Returns:

String representing the value

getDisplayName

public final String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Specified by:

getDisplayName in interface IKlvValue

Returns:

The name of the type

getParameters

public String getParameters()

Get the parameters of this metric.

Returns:

the metric parameters