org.jmisb.api.klv.st0603

Class TimeStatus

java.lang.Object

org.jmisb.api.klv.st0603.TimeStatus

public class TimeStatus
extends Object

ST0603 Time Status.

From ST0603.5 section 7.4:

Systems producing a timestamp representing Absolute Time for Motion Imagery and metadata will have differing requirements for the accuracy and precision of the timestamp. System designers need to specify both the precision and the accuracy of the timestamp, so that users of the data understand what can be expected in data analysis.

The purpose of the Time Status is twofold:

1. Provide information on the reference clock used to produce a timestamp, and

2. Provide a bit-efficient timestamp qualifier for use within Motion Imagery.

There are cases where a suitable reference for a timestamp is not available, or the synchronization to a reference may be temporarily lost. The Time Status provides end-user information regarding the reference for the timestamp in these instances.

The Time Status is a set of three flags. The reverse flag depends on the discontinuity flag, since it describes the direction of the discontinuity (jump).

Constructor Summary

Constructors

Constructor and Description
TimeStatus() Constructor.
TimeStatus(byte encoded) Create from encoded byte.

Method Summary

Modifier and Type	Method and Description
boolean	isDiscontinuity() Whether the time is discontinuous.
boolean	isLocked() Whether the time is locked or not.
boolean	isReverse() Whether the discontinuity is in the reverse direction.
void	setDiscontinuity(boolean discontinuity, boolean reverse) Set whether the time is discontinuous.
void	setLocked(boolean locked) Set whether the time is locked or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeStatus

public TimeStatus()

Constructor.

This will create a "non-locked, forward linear" status.

TimeStatus

public TimeStatus(byte encoded)

Create from encoded byte.

Parameters:

encoded - Encoded byte

Method Detail

isLocked

public boolean isLocked()

Whether the time is locked or not.

Locked means that the internal clock is locked to absolute time reference. Not locked also covers the "lock status is unknown" case.

Returns:

true if the time is locked, false if the time is not locked.

setLocked

public void setLocked(boolean locked)

Set whether the time is locked or not.

Locked means that the internal clock is locked to absolute time reference. Not locked also covers the "lock status is unknown" case.

Parameters:

locked - true if the time is locked, false if the time is not locked.

isDiscontinuity

public boolean isDiscontinuity()

Whether the time is discontinuous.

A discontinuity means that time has not incremented forward in a linear fashion. That is, a forward non-linear or reverse jump as a by-product of relocking the clock to a reference, or other correction.

Returns:

true if there is a discontinuity, or false if time is incrementing in a normal linear fashion.

setDiscontinuity

public void setDiscontinuity(boolean discontinuity,
                             boolean reverse)

Set whether the time is discontinuous.

A discontinuity means that time has not incremented forward in a linear fashion. That is, a forward non-linear or reverse jump as a by-product of relocking the clock to a reference, or other correction.

Parameters:

discontinuity - true if there is a discontinuity, or false if time is incrementing in a normal linear fashion.

reverse - true if the discontinuity is a reverse jump, or false if the discontinuity is a forward jump.

isReverse

public boolean isReverse()

Whether the discontinuity is in the reverse direction.

Only meaningful if there is a discontinuity (see isDiscontinuity()).

Returns:

true if the discontinuity is reverse direction (step back), otherwise false.