org.jmisb.api.klv.st0601

Class SensorFrameRate

java.lang.Object

org.jmisb.api.klv.st0601.SensorFrameRate

All Implemented Interfaces:

IKlvValue, IUasDatalinkValue

public class SensorFrameRate
extends Object
implements IUasDatalinkValue

Sensor Frame Rate (ST 0601 Item 127).

From ST:

The Sensor Frame Rate Pack consists of two unsigned integers used to compute the frame rate. The ratio of the two integers provides the capability to compute both integer and drop-frame frame rates. For example, typical integer frame rates of 30, 60 are the ratio of 30/1 and 60/1, respectively. While drop-frame rates of 29.97 and 59.94 are the ratio of 30000/1001 and 60000/1001, respectively.

The Sensor Frame Rate Pack is a two-element truncation pack where the first element is the numerator in BER-OID format, and the second element is the denominator in BER-OID format.

Constructor Summary

Constructors

Constructor and Description
SensorFrameRate(byte[] bytes) Create from encoded bytes.
SensorFrameRate(int numerator) Create from value.
SensorFrameRate(int numerator, int denominator) Create from values.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Get the encoded bytes.
int	getDenominator() Get the denominator part of the frame rate.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
double	getFrameRate() Get the resulting frame rate.
int	getNumerator() Get the numerator part of the frame rate.

Methods inherited from class java.lang.Object

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

Constructor Detail

SensorFrameRate

public SensorFrameRate(int numerator,
                       int denominator)

Create from values.

Parameters:

numerator - the numerator part of the rate.

denominator - the denominator part of the rate.

SensorFrameRate

public SensorFrameRate(int numerator)

Create from value.

Parameters:

numerator - the numerator part of the rate.

SensorFrameRate

public SensorFrameRate(byte[] bytes)

Create from encoded bytes.

Parameters:

bytes - encoded value

Method Detail

getBytes

public byte[] getBytes()

Description copied from interface: IUasDatalinkValue

Get the encoded bytes.

Specified by:

getBytes in interface IUasDatalinkValue

Returns:

The encoded byte array

getFrameRate

public double getFrameRate()

Get the resulting frame rate.

Returns:

Frame rate as a floating point value.

getNumerator

public int getNumerator()

Get the numerator part of the frame rate.

Returns:

frame rate ratio numerator

getDenominator

public int getDenominator()

Get the denominator part of the frame rate.

Returns:

frame rate ratio denominator

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