org.lsst.ccs.subsystem.shutter.plc

Class CalibDone

java.lang.Object

org.lsst.ccs.subsystem.shutter.plc.PLCMsg

org.lsst.ccs.subsystem.shutter.plc.MsgToCCS

org.lsst.ccs.subsystem.shutter.plc.CalibDone

public class CalibDone
extends MsgToCCS

Contains a CalibDone message sent from the PLC.

Author:

tether

Field Summary

Fields inherited from class org.lsst.ccs.subsystem.shutter.plc.PLCMsg

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
CalibDone(ByteBuffer data) Reads and converts the PLC form of the message.
CalibDone(int sequence, double[] homePosition, double[] deployedPosition, DoubleSupplier supplier) Creates the message from scratch.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Puts the sequence number into a data buffer.
double	getDeployedPosition(Axis ax) Returns the deployed position for an axis.
double[]	getHallTransitions(Axis axis, Direction direction) Returns the set of Hall transition positions for a given axis and direction of travel.
double	getHomePosition(Axis ax) Returns the home position for an axis.
String	toString() Converts the message to a readable string.

Methods inherited from class org.lsst.ccs.subsystem.shutter.plc.PLCMsg

getVersion, messageVersionIsBad

Methods inherited from class java.lang.Object

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

Constructor Detail

CalibDone

public CalibDone(int sequence,
                 double[] homePosition,
                 double[] deployedPosition,
                 DoubleSupplier supplier)

Creates the message from scratch.

Parameters:

sequence - A message sequence number.

homePosition - Axis blade set home positions (home = fully retracted).

deployedPosition - Axis blade set deployed positions (fully extended).

supplier - The supplier of double values for the Hall calibration. Used to fill the internal map of Hall transition positions which has "dimensions" [axis number][direction][transitions per direction]. The order is row-major, Axis 0 comes before Axis 1, positive direction comes before negative. 240 values are expected for each combination of axis and direction.

See Also:

Axis, Direction

CalibDone

public CalibDone(ByteBuffer data)

Reads and converts the PLC form of the message.

Parameters:

data - The PLC message data.

Method Detail

encode

public void encode(ByteBuffer data)

Description copied from class: MsgToCCS

Puts the sequence number into a data buffer.

Overrides:

encode in class MsgToCCS

Parameters:

data - The buffer.

getHallTransitions

public double[] getHallTransitions(Axis axis,
                                   Direction direction)

Returns the set of Hall transition positions for a given axis and direction of travel.

Parameters:

axis - The axis.

direction - The direction of travel.

Returns:

The array of coordinates of the requested Hall transition.

getHomePosition

public double getHomePosition(Axis ax)

Returns the home position for an axis.

Parameters:

ax - The axis.

Returns:

The home position calculated from the axis homing routine.

getDeployedPosition

public double getDeployedPosition(Axis ax)

Returns the deployed position for an axis.

Parameters:

ax - The axis.

Returns:

The deployed position calculated from the axis homing routine.

toString

public String toString()

Description copied from class: PLCMsg

Converts the message to a readable string.

Overrides:

toString in class MsgToCCS

Returns:

The string form of the message. The short message class name will come first followed by the field names and values enclosed in curly braces. For example, if message Foo is sent from CCS to the PLC it will inherit from MsgToPLC and look something like this: FooMessage{MsgToPLC{PLCMsg{...} ...} field1=val1, ...}