org.lsst.ccs.subsystem.shutter.plc

Class ChangeBrakeState

java.lang.Object

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

org.lsst.ccs.subsystem.shutter.plc.MsgToPLC

org.lsst.ccs.subsystem.shutter.plc.ChangeBrakeState

public class ChangeBrakeState
extends MsgToPLC

Signals the PLC to engage or release a brake.

Author:

tether

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangeBrakeState.State Possible brake states.

Field Summary

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

subsystemUUID

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

MESSAGE_SET_VERSION

Constructor Summary

Constructors

Constructor and Description
ChangeBrakeState(Axis axis, ChangeBrakeState.State state) Constructs from the field values.
ChangeBrakeState(ByteBuffer data) Reads and converts the PLC form of the message.

Method Summary

Modifier and Type	Method and Description
void	encode(ByteBuffer data) Converts the message fields to PLC form and appends them to a byte buffer.
Axis	getAxis()
ChangeBrakeState.State	getState()
String	toString() Converts the message to a readable string.

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

hasSameIdent

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

ChangeBrakeState

public ChangeBrakeState(Axis axis,
                        ChangeBrakeState.State state)

Constructs from the field values.

Parameters:

axis - Identifies the axis.

state - The desired brake state.

ChangeBrakeState

public ChangeBrakeState(ByteBuffer data)

Reads and converts the PLC form of the message.

Parameters:

data - The PLC message data buffer.

Method Detail

encode

public void encode(ByteBuffer data)

Description copied from class: PLCMsg

Converts the message fields to PLC form and appends them to a byte buffer.

Overrides:

encode in class MsgToPLC

Parameters:

data - Holds the PLC message data.

getState

public ChangeBrakeState.State getState()

getAxis

public Axis getAxis()

toString

public String toString()

Description copied from class: PLCMsg

Converts the message to a readable string.

Overrides:

toString in class MsgToPLC

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, ...}