org.lsst.ccs.subsystem.shutter.status

Class MotionDone

java.lang.Object

org.lsst.ccs.subsystem.shutter.status.MotionDone

All Implemented Interfaces:

Serializable

@SkipEncoding
public final class MotionDone
extends Object
implements Serializable

Carries trajectory information from a single blade set motion. This carries enough information to plot the actual motion as well as a prediction based on a given motion profile.

Immutable.

Author:

tether

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MotionDone.Builder A builder for instances of MotionsDone.

Method Summary

Modifier and Type	Method and Description
Duration	actualDuration()
List<EncoderSample>	encoderSamples()
double	endPosition()
List<HallTransition>	hallTransitions()
boolean	isDummy() Is this a dummy, just used to signal the end of a non-standard motion such as axis homing? A dummy has no Hall transitions or encoder samples.
ShutterSide	side()
double	startPosition()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	startTime()
Duration	targetDuration()
double	targetPosition()
String	toString() Creates a string of the form 'MotionDone{field=value, ...}'.

Methods inherited from class java.lang.Object

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

Method Detail

side

public ShutterSide side()

Returns:

The side of the shutter whose blade sets moved.

startPosition

public double startPosition()

Returns:

The encoder value at the time motion was started.

startTime

public org.lsst.ccs.utilities.taitime.CCSTimeStamp startTime()

Returns:

The absolute time at which motion started.

targetPosition

public double targetPosition()

Returns:

The intended final position of the blade set.

targetDuration

public Duration targetDuration()

Returns:

The intended duration of the motion. This will either have been provided as parameter of the motion or derived from other parameters such as speed and distance.

endPosition

public double endPosition()

Returns:

The actual final position of the blade set.

actualDuration

public Duration actualDuration()

Returns:

The actual duration of the motion.

encoderSamples

public List<EncoderSample> encoderSamples()

Returns:

The encoder samples that were taken during the motion.

hallTransitions

public List<HallTransition> hallTransitions()

Returns:

The Hall transitions that took place during the motion.

toString

public String toString()

Creates a string of the form 'MotionDone{field=value, ...}'.

Overrides:

toString in class Object

Returns:

The string.

isDummy

public boolean isDummy()

Is this a dummy, just used to signal the end of a non-standard motion such as axis homing? A dummy has no Hall transitions or encoder samples.

Returns:

true if this is a dummy message, else false.