org.jmisb.api.klv.st1108.st1108_2

Class ChipFrequencyRatio

java.lang.Object

org.jmisb.api.klv.st1108.st1108_2.ChipFrequencyRatio

All Implemented Interfaces:

IKlvValue, IInterpretabilityQualityMetadataValue

public class ChipFrequencyRatio
extends Object
implements IInterpretabilityQualityMetadataValue

Chip Frequency Ratio (ST 1108.2 Tag 13).

The Chip Frequency Ratio is computed by taking the ratio of high-pass to low-pass energy.

See ST 1108.2 Section 7.13 and RP 1203.3.

Constructor Summary

Constructors

Constructor and Description
ChipFrequencyRatio(byte[] bytes) Create from encoded bytes.
ChipFrequencyRatio(int ratio) Create from value.

Method Summary

Modifier and Type	Method and Description
void	appendBytesToBuilder(ArrayBuilder arrayBuilder) Append the encoded bytes for this item to the byte array builder.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
int	getRatio() Get the frequency ratio.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChipFrequencyRatio

public ChipFrequencyRatio(int ratio)

Create from value.

Parameters:

ratio - The chip frequency ratio.

ChipFrequencyRatio

public ChipFrequencyRatio(byte[] bytes)

Create from encoded bytes.

Parameters:

bytes - Byte array of length 2 bytes.

Method Detail

getRatio

public int getRatio()

Get the frequency ratio.

Returns:

The ratio as an unscaled integer value

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

appendBytesToBuilder

public void appendBytesToBuilder(ArrayBuilder arrayBuilder)

Description copied from interface: IInterpretabilityQualityMetadataValue

Append the encoded bytes for this item to the byte array builder.

This includes the tag value, and field length.

Specified by:

appendBytesToBuilder in interface IInterpretabilityQualityMetadataValue

Parameters:

arrayBuilder - the builder to append to.