MotionDone.Builder (LSST CCS - Shutter Buses 4.19 API)

java.lang.Object
- org.lsst.ccs.subsystem.shutter.status.MotionDone.Builder

Enclosing class:

MotionDone
```
public static final class MotionDone.Builder
extends Object
```
A builder for instances of MotionsDone. Allows you to specify the required components one a a time before calling build(). The other methods each return this in order to allow chaining. Hall transitions and encoder samples may be added in any order since the complete list of each will be sorted before constructing the instance of MotionDone.
Not thread-safe at all, as it's intended as a substitute for a public constructor.

Constructor Summary

Constructors
Constructor and Description
`Builder()` Use this constructor for normal purposes.
`Builder(boolean noThrow)` Use this constructor only when you need to construct faulty instances of `MotionDone` for tests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MotionDone.Builder`	`actualDuration(Duration dur)`
`MotionDone.Builder`	`addEncoderSample(EncoderSample samp)` Adds a single new encoder sample to any already present.
`MotionDone.Builder`	`addHallTransition(HallTransition hall)` Appends a single new Hall transition to any already present.
`MotionDone`	`build()` Sorts the lists of Hall transitions and encoder samples, performs some checks and the constructs an instance of `MotionDone`.
`MotionDone.Builder`	`encoderSamples(List<EncoderSample> samps)`
`MotionDone.Builder`	`endPosition(double pos)`
`MotionDone.Builder`	`hallTransitions(List<HallTransition> halls)`
`MotionDone.Builder`	`side(ShutterSide side)`
`MotionDone.Builder`	`startPosition(double pos)`
`MotionDone.Builder`	`startTime(org.lsst.ccs.utilities.taitime.CCSTimeStamp time)`
`MotionDone.Builder`	`targetDuration(Duration dur)`
`MotionDone.Builder`	`targetPosition(double pos)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Use this constructor for normal purposes. Failed checks will result in the throwing of exceptions.
  - Builder
```
public Builder(boolean noThrow)
```
    Use this constructor only when you need to construct faulty instances of MotionDone for tests.
    
    Parameters:
    
    noThrow - If true then failed checks will throw exceptions, otherwise they will log warning messages.
- Method Detail
  - side
```
public MotionDone.Builder side(ShutterSide side)
```
    Parameters:
    
    side -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.side()
  - startPosition
```
public MotionDone.Builder startPosition(double pos)
```
    Parameters:
    
    pos -
    
    Returns:
    
    See Also:
    
    MotionDone.startPosition()
  - startTime
```
public MotionDone.Builder startTime(org.lsst.ccs.utilities.taitime.CCSTimeStamp time)
```
    Parameters:
    
    time -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.startTime()
  - targetPosition
```
public MotionDone.Builder targetPosition(double pos)
```
    Parameters:
    
    pos -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.targetPosition()
  - endPosition
```
public MotionDone.Builder endPosition(double pos)
```
    Parameters:
    
    pos -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.endPosition()
  - targetDuration
```
public MotionDone.Builder targetDuration(Duration dur)
```
    Parameters:
    
    dur -
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if the duration is non-positive, unless the no-throwing was chosen in the constructor.
    
    See Also:
    
    MotionDone.targetDuration()
  - actualDuration
```
public MotionDone.Builder actualDuration(Duration dur)
```
    Parameters:
    
    dur -
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if the duration is non-positive.
    
    See Also:
    
    MotionDone.actualDuration()
  - encoderSamples
```
public MotionDone.Builder encoderSamples(List<EncoderSample> samps)
```
    Parameters:
    
    samps -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.encoderSamples()
  - addEncoderSample
```
public MotionDone.Builder addEncoderSample(EncoderSample samp)
```
    Adds a single new encoder sample to any already present.
    
    Parameters:
    
    samp -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.encoderSamples()
  - hallTransitions
```
public MotionDone.Builder hallTransitions(List<HallTransition> halls)
```
    Parameters:
    
    halls -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.hallTransitions()
  - addHallTransition
```
public MotionDone.Builder addHallTransition(HallTransition hall)
```
    Appends a single new Hall transition to any already present.
    
    Parameters:
    
    hall -
    
    Returns:
    
    this
    
    See Also:
    
    MotionDone.hallTransitions()
  - build
```
public MotionDone build()
```
    Sorts the lists of Hall transitions and encoder samples, performs some checks and the constructs an instance of MotionDone.
    
    Returns:
    
    A new instance of MotionDone.
    
    Throws:
    
    IllegalStateException - if any of the required components are missing, unless no-throwing was selected in the constructor.

Class MotionDone.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

side

startPosition

startTime

targetPosition

endPosition

targetDuration

actualDuration

encoderSamples

addEncoderSample

hallTransitions

addHallTransition

build