A B C D E F G H I M O P S T V W

A

acceleration(double) - Method in class org.lsst.ccs.subsystem.shutter.sim.CubicSCurve

acceleration(double) - Method in interface org.lsst.ccs.subsystem.shutter.sim.MotionProfile

Gives the acceleration of the blade set at time t.

actualDuration() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

actualDuration(Duration) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

addEncoderSample(EncoderSample) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Adds a single new encoder sample to any already present.

addHallTransition(HallTransition) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Appends a single new Hall transition to any already present.

atHighLimit() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Is the axis at the high limit switch?

atLowLimit() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Is the axis at the the low limit switch?

Axis - Enum in org.lsst.ccs.subsystem.shutter.common

The axes available on the shutter, one per blade set.

AxisStatus(double, double, double, boolean, boolean, boolean, boolean, boolean, int, double) - Constructor for class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Constructs from scratch.

B

BLADE_SET_HOME - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The home positions, in mm, for each blade set.

build() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Sorts the lists of Hall transitions and encoder samples, performs some checks and the constructs an instance of MotionDone.

Builder() - Constructor for class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Use this constructor for normal purposes.

Builder(boolean) - Constructor for class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Use this constructor only when you need to construct faulty instances of MotionDone for tests.

C

compareTo(TimeOrdered) - Method in interface org.lsst.ccs.subsystem.shutter.common.TimeOrdered

Constants - Class in org.lsst.ccs.subsystem.shutter.common

CubicSCurve - Class in org.lsst.ccs.subsystem.shutter.sim

Defines a piecewise cubic S-curve motion profile.

CubicSCurve(double, double) - Constructor for class org.lsst.ccs.subsystem.shutter.sim.CubicSCurve

Sets the scale factors for distance moved and total elapsed time.

D

distance(double) - Method in class org.lsst.ccs.subsystem.shutter.sim.CubicSCurve

distance(double) - Method in interface org.lsst.ccs.subsystem.shutter.sim.MotionProfile

Gives the distance traveled by the blade set at time t.

E

EncoderSample - Class in org.lsst.ccs.subsystem.shutter.common

Immutable class containing the data for a single position encoder sample.

EncoderSample(CCSTimeStamp, double) - Constructor for class org.lsst.ccs.subsystem.shutter.common.EncoderSample

Constructs from field values.

encoderSamples(List<EncoderSample>) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

encoderSamples() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

endPosition(double) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

endPosition() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

F

fromAxis(Axis) - Static method in enum org.lsst.ccs.subsystem.shutter.common.ShutterSide

fromAxisNum(int) - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Find the Axis value having the given PLC axis number.

fromName(String) - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Find the Axis value having the given axis name.

G

getAcceleration() - Method in class org.lsst.ccs.subsystem.shutter.sim.PredictedPosition

Gets the acceleration in units of 1/sec/sec.

getActPos() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Gets the actual position of the axis.

getActVel() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Gets the actual velocity of the axis.

getAxisStatus(ShutterSide) - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Gets the status info for one of the blade set axes.

getDescription() - Method in enum org.lsst.ccs.subsystem.shutter.common.SoftwareState

getErrorID() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Gets the error code for the axis.

getMinusXSide() - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Gets the axis that's controlling the blade set on the -X side.

getMotionProfile() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Gets the motion profile in use

getMotorTemp() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Gets the axis motor temperature reading.

getName() - Method in enum org.lsst.ccs.subsystem.shutter.common.Axis

The name used for the axis in motorplatform commands.

getNormalizedPosition(double) - Method in enum org.lsst.ccs.subsystem.shutter.common.ShutterSide

getPLCAxisNum() - Method in enum org.lsst.ccs.subsystem.shutter.common.Axis

The axis number used by the PLC code.

getPlusXSide() - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Gets the axis that's controlling the blade set on the +X side.

getPosition() - Method in class org.lsst.ccs.subsystem.shutter.common.EncoderSample

Gets the sampled encoder position.

getPosition() - Method in class org.lsst.ccs.subsystem.shutter.common.HallTransition

Gets the absolute position of the transition.

getPosition() - Method in class org.lsst.ccs.subsystem.shutter.sim.PredictedPosition

Gets the position.

getPositions() - Method in class org.lsst.ccs.subsystem.shutter.sim.PredictedTrajectory

Returns the time-ordered list of predicted positions (and accelerations, etc.).

getSensorId() - Method in class org.lsst.ccs.subsystem.shutter.common.HallTransition

Gets the Hall sensor ID number.

getSetAcc() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Gets the "set", or commanded, acceleration of the axis.

getSmState() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Gets the current state for the shutter controller's state machine.

getTime() - Method in class org.lsst.ccs.subsystem.shutter.common.EncoderSample

Gets the time at which the position sample was taken..

getTime() - Method in class org.lsst.ccs.subsystem.shutter.common.HallTransition

Gets the time of the transition.

getTime() - Method in interface org.lsst.ccs.subsystem.shutter.common.TimeOrdered

getTime() - Method in class org.lsst.ccs.subsystem.shutter.sim.PredictedPosition

Gets the time of the sample.

getVelocity() - Method in class org.lsst.ccs.subsystem.shutter.sim.PredictedPosition

Gets the velocity in units of 1/sec.

H

HallTransition - Class in org.lsst.ccs.subsystem.shutter.common

Immutable class containing the data for a transition of a Hall sensor.

HallTransition(CCSTimeStamp, int, double, boolean) - Constructor for class org.lsst.ccs.subsystem.shutter.common.HallTransition

Full constructor.

hallTransitions(List<HallTransition>) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

hallTransitions() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

I

INTERAXIS_OFFSET - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The offset in mm from the encoder coordinate origin for the +X blade set to that of the -X blade set.

inverseDistance(double) - Method in class org.lsst.ccs.subsystem.shutter.sim.CubicSCurve

inverseDistance(double) - Method in interface org.lsst.ccs.subsystem.shutter.sim.MotionProfile

Provides the time t at which the distance had a given value d.

isBrakeEngaged() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Is the brake set on this axis?

isCalibrated() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Is a good calibration in effect?

isEnabled() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Is the axis enabled for motion?

isHomed() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Has the homing operation been performed on this axis since the last controller reset?

isOn() - Method in class org.lsst.ccs.subsystem.shutter.common.HallTransition

Gets the polarity of the Hall transition.

isPlusXSide() - Method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Tells whether the axis is for the +X blade set or the -X.

M

MAX_STROKE_LENGTH - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The furthest distance, in mm, that a blade set can get from its home position.

MotionDone - Class in org.lsst.ccs.subsystem.shutter.status

Carries trajectory information from a single blade set motion.

MotionDone.Builder - Class in org.lsst.ccs.subsystem.shutter.status

A builder for instances of MotionsDone.

MotionProfile - Interface in org.lsst.ccs.subsystem.shutter.sim

Describes the physical motion of a blade set.

O

opposite() - Method in enum org.lsst.ccs.subsystem.shutter.common.ShutterSide

Gets the side opposite to this side.

org.lsst.ccs.subsystem.shutter.common - package org.lsst.ccs.subsystem.shutter.common

Contains classes and interfaces that are used by both GUI and worker subsystems, whether using simulated or real hardware.

org.lsst.ccs.subsystem.shutter.sim - package org.lsst.ccs.subsystem.shutter.sim

Contains the code which simulates shutter hardware.

org.lsst.ccs.subsystem.shutter.status - package org.lsst.ccs.subsystem.shutter.status

Contains the status bus message classes specific to the shutter.

P

PHYSICAL_STATE_PATH - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The path used to access the PhysicalState value in the state bundle of status messages sent from the shutter worker subsystem.

PhysicalState - Enum in org.lsst.ccs.subsystem.shutter.common

Descriptions of the current state of the shutter as reported to OCS, regardless of the internal state of the state machine used by the subsystem to control the shutter.

PredictedPosition - Class in org.lsst.ccs.subsystem.shutter.sim

A data point in the prediction of a blade set trajectory.

PredictedPosition(CCSTimeStamp, double, double, double) - Constructor for class org.lsst.ccs.subsystem.shutter.sim.PredictedPosition

Constructs an instance from the field values.

PredictedTrajectory - Class in org.lsst.ccs.subsystem.shutter.sim

Samples a motion profile function to produce a stream of PredictedPosition objects.

PredictedTrajectory(double, CCSTimeStamp, Duration, int, MotionProfile) - Constructor for class org.lsst.ccs.subsystem.shutter.sim.PredictedTrajectory

Samples the given physical motion profile.

S

ShutterSide - Enum in org.lsst.ccs.subsystem.shutter.common

Represents the two sides of the camera X axis.

ShutterStatus - Class in org.lsst.ccs.subsystem.shutter.status

Holds a ShutterStatus message sent from the PLC.

ShutterStatus(int, boolean, int, Map<ShutterSide, ShutterStatus.AxisStatus>) - Constructor for class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Constructs from scratch.

ShutterStatus.AxisStatus - Class in org.lsst.ccs.subsystem.shutter.status

Holds the status report for a single axis in a ShutterStatus message.

side(ShutterSide) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

side() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

SOFTWARE_STATE_PATH - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The path used to access the SoftwareState value in the state bundle of status messages sent from the shutter worker subsystem.

SoftwareState - Enum in org.lsst.ccs.subsystem.shutter.common

Describes the internal state of the CCS worker subsystem used to control the shutter.

startPosition(double) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

startPosition() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

startTime(CCSTimeStamp) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

startTime() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

T

targetDuration(Duration) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

targetDuration() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

targetPosition(double) - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

targetPosition() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

timeDiff(CCSTimeStamp) - Method in interface org.lsst.ccs.subsystem.shutter.common.TimeOrdered

Calculates the time difference between this.getTime() and a reference timestamp.

timeDiff(TimeOrdered) - Method in interface org.lsst.ccs.subsystem.shutter.common.TimeOrdered

Calculates the time difference between this.getTime() and a reference TimeOrdered object.

TimeOrdered - Interface in org.lsst.ccs.subsystem.shutter.common

For objects that have a natural time ordering using CCS timestamps.

toString() - Method in class org.lsst.ccs.subsystem.shutter.status.MotionDone

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

toString() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus.AxisStatus

Constructs a string of the form 'AxisStatus{fieldname=value, ...}'

toString() - Method in class org.lsst.ccs.subsystem.shutter.status.ShutterStatus

Creates a string of the format 'ShutterStatus{fieldName=value, ..., axstatus[PLUSX]= AxisStatus{...}, axstatus[MINUSX]=AxisStatus{...}}'.

V

valueOf(String) - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.subsystem.shutter.common.PhysicalState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.subsystem.shutter.common.ShutterSide

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.lsst.ccs.subsystem.shutter.common.SoftwareState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.lsst.ccs.subsystem.shutter.common.Axis

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.subsystem.shutter.common.PhysicalState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.subsystem.shutter.common.ShutterSide

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.lsst.ccs.subsystem.shutter.common.SoftwareState

Returns an array containing the constants of this enum type, in the order they are declared.

velocity(double) - Method in class org.lsst.ccs.subsystem.shutter.sim.CubicSCurve

velocity(double) - Method in interface org.lsst.ccs.subsystem.shutter.sim.MotionProfile

Gives the velocity of the blade set at time t.

W

WORKER_SUBSYSTEM_NAME - Static variable in class org.lsst.ccs.subsystem.shutter.common.Constants

The name which the worker subsystem will use on the status bus.

A B C D E F G H I M O P S T V W