Index (LSST CCS - Shutter Buses 2.0 API)

A B C D G H I J M N O P R S T U V W

A

acceleration(double) - Method in class org.lsst.ccs.subsystems.shutter.sim.CubicSCurve
acceleration(double) - Method in interface org.lsst.ccs.subsystems.shutter.sim.MotionProfile: Gives the acceleration of the blade set at time t.
apply(MotorPosition) - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorEncoderSimulator

B

BladePosition - Class in org.lsst.ccs.subsystems.shutter.common: Immutable class containing the data for a single blade position sample.
BladePosition(long, double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.common.BladePosition: Constructs given all three values.
BladePosition(double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.common.BladePosition: Constructs given the position values.
BladePositionResult - Class in org.lsst.ccs.subsystems.shutter.status: Sent by the shutter worker as the result of the getBladePositions() action command.
BladePositionResult(double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.BladePositionResult: Constructs an instance from the two blade set positions.
BladeSet - Interface in org.lsst.ccs.subsystems.shutter.common: The interface to software controlling a single blade set, real or simulated.
BladeSetCalibration - Class in org.lsst.ccs.subsystems.shutter.common: Class to hold blade calibration data.
BladeSetCalibration(int, List<BladeSetCalibration.Item>) - Constructor for class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration: Constructs from a status value and a list of Items.
BladeSetCalibration.Item - Class in org.lsst.ccs.subsystems.shutter.common: Inner class to hold a single blade calibration data item, corresponding to a change of state, or transition, of a Hall sensor.
BladeSetConfiguration - Class in org.lsst.ccs.subsystems.shutter.common: Contains low-level hardware information and a set of calibration data for one blade set.
BladeSetConfiguration(int) - Constructor for class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Constructs a configuration for a given blade set.
BladeSetSimulator - Class in org.lsst.ccs.subsystems.shutter.sim: Describes one simulated blade set.
BladeSetSimulator(int) - Constructor for class org.lsst.ccs.subsystems.shutter.sim.BladeSetSimulator: Sets the index and initial relative position of the blade set.

C

CloseShutterStatus - Class in org.lsst.ccs.subsystems.shutter.status: Published by the shutter worker in acknowledgment of a close command.
CloseShutterStatus(int, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.CloseShutterStatus: Construct.
CubicSCurve - Class in org.lsst.ccs.subsystems.shutter.sim: Defines a piecewise cubic S-curve motion profile.
CubicSCurve(double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.sim.CubicSCurve: Sets the scale factors for distance moved and total elapsed time.

D

distance(double) - Method in class org.lsst.ccs.subsystems.shutter.sim.CubicSCurve
distance(double) - Method in interface org.lsst.ccs.subsystems.shutter.sim.MotionProfile: Gives the distance traveled by the blade set at time t.

G

getAcceleration() - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorPosition: Gets the acceleration in units of 1/sec/sec.
getAdAddr() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the ISA base address of the Helios ADC unit.
getAdLevel() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the IRQ level of the Helios ADC unit.
getAdTempChn() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the number of the Helios ADC channel connected to the motor temperature output.
getBladeMovementTime() - Method in class org.lsst.ccs.subsystems.shutter.status.ShutterConfigStatus: Gets the blade movement time.
getBladeSetApproachMin() - Method in class org.lsst.ccs.subsystems.shutter.status.ShutterConfigStatus: Gets the minimum approach distance for the blade sets.
getBladeSetConfiguration() - Method in interface org.lsst.ccs.subsystems.shutter.common.BladeSet: Gets the configuration of the BladeSet.
getBladeSetConfiguration() - Method in class org.lsst.ccs.subsystems.shutter.sim.BladeSetSimulator: Not yet supported.
getBladeSetEndTol() - Method in class org.lsst.ccs.subsystems.shutter.status.ShutterConfigStatus: Gets the blade set "end tolerance".
getBladeSetIndex() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the index of the blade set that moved.
getCalibration() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the current Hall sensor calibration for the blade set.
getClosed() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the absolute position in mm of the blade set when it's considered fully extended.
getCurrentPosition() - Method in interface org.lsst.ccs.subsystems.shutter.common.BladeSet: Gets the current position of the BladeSet.
getCurrentPosition() - Method in class org.lsst.ccs.subsystems.shutter.sim.BladeSetSimulator: Gets the current relative position of the edge of the blade set.
getData() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration: Gets the list of transition items.
getDioAddr() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the base address in ISA space of the Acces I/O card.
getDioConf() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the value to place in the configuration register of the Acces I/O card.
getDioHPort() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the ISA space offset of the Acces I/O register serving inputs from the Hall sensors.
getDioILine() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the number of the Acces input line connected to the motor controller's "output 33".
getDioIPort() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the ISA space offset of the Acces I/O register serving inputs from the motor controller.
getDioLevel() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the IRQ level of the Acces I/O card.
getDioOLine() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the number of the Acces output line connected to the motor controller's "input 4".
getDioOPort() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the ISA space offset of the Acces I/O register serving outputs to the motor controller.
getEndPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the position at the end of the movement.
getEndTime() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the end time of the movement in Epoch microseconds.
getExposureTime() - Method in class org.lsst.ccs.subsystems.shutter.status.TakeExposureStatus: Gets the exposure time in seconds.
getfirstBladeSetIndex() - Method in class org.lsst.ccs.subsystems.shutter.status.CloseShutterStatus: Gets the index, 0 or 1, of the first blade set to be moved in the close operation.
getfirstBladeSetIndex() - Method in class org.lsst.ccs.subsystems.shutter.status.OpenShutterStatus: Gets the index, 0 or 1, of the first blade set to be moved in the open operation.
getfirstBladeSetIndex() - Method in class org.lsst.ccs.subsystems.shutter.status.TakeExposureStatus: Gets the index, 0 or 1, of the first blade set to be moved for this command.
getHallTransitions() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the time-ordered list of Hall Sensor transitions generated by this movement.
getHistory() - Method in class org.lsst.ccs.subsystems.shutter.status.MovementHistoryStatus: Get the embedded MovementHistory object.
getHome() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the absolute home position of the blade set in mm.
getIndex() - Method in interface org.lsst.ccs.subsystems.shutter.common.BladeSet: Gets the index of the blade set.
getIndex() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Gets the index used to distinguish members of a set of consecutive transitions.
getIndex() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the index, 0 or 1, of the blade set described by this object.
getIndex() - Method in class org.lsst.ccs.subsystems.shutter.sim.BladeSetSimulator: Gets the index.
getIndex() - Method in class org.lsst.ccs.subsystems.shutter.status.MovementHistoryStatus: Get the index, 0 or 1, of the blade set that was moved.
getIndex() - Method in class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Gets the index, 0 or 1, of the blade set that will be moved.
getKey() - Method in enum org.lsst.ccs.subsystems.shutter.status.StatusKey: Retrieve the key value.
getMoveTime() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the default duration in seconds of each blade set motion.
getMoveTime() - Method in class org.lsst.ccs.subsystems.shutter.status.CloseShutterStatus: Gets the duration in seconds of each blade set move.
getMoveTime() - Method in class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Gets the time in seconds that the blade set motion will take.
getMoveTime() - Method in class org.lsst.ccs.subsystems.shutter.status.OpenShutterStatus: Gets the duration in seconds of each blade set move.
getMoveTime() - Method in class org.lsst.ccs.subsystems.shutter.status.TakeExposureStatus: Gets the duration in seconds of each blade set move.
getNode() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the IP address of the motor controller for the blade set.
getNumSamp() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the number of motor position samples to be taken during each blade set motion.
getOpen() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the absolute position in mm of the blade set when it's considered fully retracted and ready for motion.
getPos0() - Method in class org.lsst.ccs.subsystems.shutter.status.BladePositionResult: Gets the relative position of blade set 0.
getPos1() - Method in class org.lsst.ccs.subsystems.shutter.status.BladePositionResult: Gets the relative position of blade set 1.
getPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.BladePosition: Gets the sampled absolute position.
getPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Gets the absolute position of the transition.
getPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Gets the absolute position of the transition.
getPosition() - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorPosition: Gets the relative position.
getPositions() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets a time-ordered list of BladePositions generated by the move.
getPositions() - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorSimulator: Returns the motor positions as a stream.
getPpMm() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the pulses-per-millimeter for the blade set's motor position encoder.
getRelPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.BladePosition: Gets the relative position calculated from the absolute position.
getRelPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Gets the relative position of the transition.
getSensor() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Gets the Hall sensor ID number.
getSensorId() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Gets the Hall sensor ID number.
getStartingPosition() - Method in class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Gets the starting relative position.
getStartPosition() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the position at the beginning of the movement.
getStartTime() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the start time of the movement in Epoch microseconds.
getStartTime() - Method in class org.lsst.ccs.subsystems.shutter.status.CloseShutterStatus: Gets the time at which the worker subsystem started executing the command.
getStartTime() - Method in class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Gets the time at which the worker subsystem started executing the command.
getStartTime() - Method in class org.lsst.ccs.subsystems.shutter.status.OpenShutterStatus: Gets the time at which the worker subsystem started executing the command.
getStartTime() - Method in class org.lsst.ccs.subsystems.shutter.status.TakeExposureStatus: Gets the time at which the worker subsystem started executing the command.
getStatus() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration: Gets the status value for the calibration.
getStatus() - Method in class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Gets the movement completion status.
getTargetPosition() - Method in class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Gets the desired final relative position.
getTime() - Method in class org.lsst.ccs.subsystems.shutter.common.BladePosition: Gets the time at which the position sample was taken..
getTime() - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorPosition: Gets the time of the sample.
getTransitions() - Method in class org.lsst.ccs.subsystems.shutter.sim.HallSensorSimulator: Gets the time-ordered stream of Hall transitions.
getTransitionTime() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Gets the time of the transition.
getVelocity() - Method in class org.lsst.ccs.subsystems.shutter.sim.MotorPosition: Gets the velocity in units of 1/sec.

H

HallSensorSimulator - Class in org.lsst.ccs.subsystems.shutter.sim: Calculates when each Hall sensor undergoes a transition from open to closed and back to open.
HallSensorSimulator(long, double, double, MotionProfile) - Constructor for class org.lsst.ccs.subsystems.shutter.sim.HallSensorSimulator: Find all the Hall transitions relevant to the given motion of the blade set.
HallTransition - Class in org.lsst.ccs.subsystems.shutter.common: Immutable class containing the data for a single Hall sensor transition.
HallTransition(long, int, boolean, boolean, double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.common.HallTransition: Full constructor.

I

init() - Method in interface org.lsst.ccs.subsystems.shutter.common.BladeSet: Initializes any underlying hardware, etc.
inverseDistance(double) - Method in class org.lsst.ccs.subsystems.shutter.sim.CubicSCurve
inverseDistance(double) - Method in interface org.lsst.ccs.subsystems.shutter.sim.MotionProfile: Provides the time t at which the distance had a given value d.
isFirstMovement() - Method in class org.lsst.ccs.subsystems.shutter.status.MovementHistoryStatus: Is this the first movement performed for whatever command was issued?
isLastMovement() - Method in class org.lsst.ccs.subsystems.shutter.status.MovementHistoryStatus: Is this the last movement performed for whatever command was issued?
isOpen() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Gets the state of the Hall sensor after the transition.
isOpen() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Is the new state of the sensor "open"?
isReadyForAction() - Method in class org.lsst.ccs.subsystems.shutter.status.ReadyForActionStatus: Is the worker subsystem ready?
isReverse() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Gets the direction-of-motion flag for the transition.
isReverse() - Method in class org.lsst.ccs.subsystems.shutter.common.HallTransition: Was the blade set retracting when the transition occurred?
Item(int, int, double, boolean, boolean) - Constructor for class org.lsst.ccs.subsystems.shutter.common.BladeSetCalibration.Item: Constructs a single calibration item from the field values.

J

JITTER_STDDEV - Static variable in class org.lsst.ccs.subsystems.shutter.sim.MotorEncoderSimulator: The standard deviation of the jitter added to the relative position.

M

MAX_JITTER - Static variable in class org.lsst.ccs.subsystems.shutter.sim.MotorEncoderSimulator: The maximum permitted absolute value of the added jitter, i.e., where we cut off the tails of the Gaussian.
MotionProfile - Interface in org.lsst.ccs.subsystems.shutter.sim: Describes the physical motion of a blade set.
motorDistance(double) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Converts a blade set travel distance, e.g., a step size, into a change in motor coordinates.
MotorEncoderSimulator - Class in org.lsst.ccs.subsystems.shutter.sim: Makes a BladePosition from the information in a MotorPosition.
MotorEncoderSimulator() - Constructor for class org.lsst.ccs.subsystems.shutter.sim.MotorEncoderSimulator
MotorPosition - Class in org.lsst.ccs.subsystems.shutter.sim: Represents a simulated motor position sample.
MotorPosition(double, double, double, long) - Constructor for class org.lsst.ccs.subsystems.shutter.sim.MotorPosition: Constructs an instance from the field values.
MotorSimulator - Class in org.lsst.ccs.subsystems.shutter.sim: Samples a motion profile to produce a stream of MotorPosition objects.
MotorSimulator(double, double, int, long, MotionProfile) - Constructor for class org.lsst.ccs.subsystems.shutter.sim.MotorSimulator: Samples the given physical motion profile.
MovementHistory - Class in org.lsst.ccs.subsystems.shutter.common: Immutable class containing the data produced by a blade set move.
MovementHistory(int, int, long, double, long, double, List<BladePosition>, List<HallTransition>) - Constructor for class org.lsst.ccs.subsystems.shutter.common.MovementHistory: Constructs an instance from the individual field values.
MovementHistoryStatus - Class in org.lsst.ccs.subsystems.shutter.status: Used to publish motor position samples and Hall data after a blade set motion.
MovementHistoryStatus(boolean, boolean, MovementHistory) - Constructor for class org.lsst.ccs.subsystems.shutter.status.MovementHistoryStatus: Constructs an instance from flags and a MovementHistory.
moveToPosition(double, double) - Method in interface org.lsst.ccs.subsystems.shutter.common.BladeSet: Moves the blade set to the specified position.
moveToPosition(double, double) - Method in class org.lsst.ccs.subsystems.shutter.sim.BladeSetSimulator: Performs a simulated motion of the blade set.
MoveToPositionStatus - Class in org.lsst.ccs.subsystems.shutter.status: Published in acknowledgment of a moveToPosition command.
MoveToPositionStatus(double, int, double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.MoveToPositionStatus: Constructs an instance from the field values.

N

negSoftLimit() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Calculates the software lower limit on the blade set's absolute position.

O

OpenShutterStatus - Class in org.lsst.ccs.subsystems.shutter.status: Published by the shutter worker in acknowledgment of an open command.
OpenShutterStatus(int, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.OpenShutterStatus: Constructs an instance from the field values.
org.lsst.ccs.subsystems.shutter.common - package org.lsst.ccs.subsystems.shutter.common: Contains classes and interfaces that are used by both GUI and worker subsystems, whether using simulated or real hardware.
org.lsst.ccs.subsystems.shutter.sim - package org.lsst.ccs.subsystems.shutter.sim: Contains the code which simulates shutter hardware.
org.lsst.ccs.subsystems.shutter.status - package org.lsst.ccs.subsystems.shutter.status: Contains the bus message classes specific to the shutter.

P

position(int) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Converts a motor position encoder reading into absolute blade set position in mm.
position(double) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Converts a blade set relative position into an absolute position.
posSoftLimit() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Calculates the software upper limit on the blade set's absolute position.
ppu() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Gets the pulses per unit value given to the motor controller, the absolute value of what getPpm() returns.

R

readCalibration(int) - Static method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Reads a text file of Hall sensor calibration data (transition positions) from the current working directory.
readCalibration(String) - Static method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Reads a file of Hall sensor calibration data (transition positions) from a text file with the given path name (relative or absolute).
ReadyForActionStatus - Class in org.lsst.ccs.subsystems.shutter.status: Published in order to advertise that the shutter worker is ready (or not) to accept a new command.
ReadyForActionStatus(boolean) - Constructor for class org.lsst.ccs.subsystems.shutter.status.ReadyForActionStatus: Constructs an instance from a ready-flag.
relPosition(int) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Converts a motor encoder position into a relative position.
relPosition(double) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Calculates the relative position of the blade set given the absolute position.

S

ShutterConfigStatus - Class in org.lsst.ccs.subsystems.shutter.status: Used to publish all shutter configuration parameter values after any change.
ShutterConfigStatus(double, double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.ShutterConfigStatus: Construct an instance from the configuration parameter values.
StatusKey - Enum in org.lsst.ccs.subsystems.shutter.status

T

TakeExposureStatus - Class in org.lsst.ccs.subsystems.shutter.status: Published in acknowledgment of a takeExposure command.
TakeExposureStatus(int, double, double) - Constructor for class org.lsst.ccs.subsystems.shutter.status.TakeExposureStatus: Constructs an instance from the field values.
toString() - Method in class org.lsst.ccs.subsystems.shutter.status.BladePositionResult: Gives a string of the form "Blade set 0 at %6.3f, blade set 1 at %6.3f.".

U

UnsafeMoveStatus - Class in org.lsst.ccs.subsystems.shutter.status: Sent by the shutter worker in response to an unsafe moveToPosition() command.
UnsafeMoveStatus() - Constructor for class org.lsst.ccs.subsystems.shutter.status.UnsafeMoveStatus

V

valueOf(String) - Static method in enum org.lsst.ccs.subsystems.shutter.status.StatusKey: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.lsst.ccs.subsystems.shutter.status.StatusKey: Returns an array containing the constants of this enum type, in the order they are declared.
velocity(double) - Method in class org.lsst.ccs.subsystems.shutter.sim.CubicSCurve
velocity(double) - Method in interface org.lsst.ccs.subsystems.shutter.sim.MotionProfile: Gives the velocity of the blade set at time t.

W

writeCalibration() - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Saves the currently loaded Hall sensor calibration data (transition positions).
writeCalibration(BladeSetCalibration) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Saves an arbitrary Hall sensor calibration.
writeCalibration(String) - Method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Saves the currently loaded Hall sensor calibration in a non-standard location.
writeCalibration(BladeSetCalibration, String) - Static method in class org.lsst.ccs.subsystems.shutter.common.BladeSetConfiguration: Saves an arbitrary Hall sensor calibration in a non-standard location.

A B C D G H I J M N O P R S T U V W