PWMChannelConfig.Builder (Device I/O API 1.1)

java.lang.Object
- jdk.dio.pwm.PWMChannelConfig.Builder

Enclosing class:: PWMChannelConfig

public static final class PWMChannelConfig.Builder
extends java.lang.Object

The Builder class allows for creating and initializing PWMChannelConfig objects. Calls can be chained in the following manner:

   PWMChannelConfig config = new PWMChannelConfig.Builder()
           .setControllerNumber(1)
           .setChannelNumber(1)
           .setScaleFactor(1.0)
           .setPulsePeriod(10)
           .setIdleState(IDLE_STATE_HIGH)
           .setPulseAlignment(ALIGN_CENTER)
           .setOutputBufferSize(0)
           .build();

Since:: 1.1

Constructor Summary

Constructors
Constructor and Description

PWMChannelConfig.Builder()
Creates a new Builder instance.

Constructors
Constructor and Description
`PWMChannelConfig.Builder()` Creates a new `Builder` instance.

Method Summary

Methods
Modifier and Type	Method and Description
`PWMChannelConfig`	`build()` Creates a new `PWMChannelConfig` instance initialized with the values set for each configuration parameters.
`PWMChannelConfig.Builder`	`setChannelNumber(int channelNumber)` Sets the channel number (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setControllerName(java.lang.String controllerName)` Sets the controller name (default value is `null` if not set).
`PWMChannelConfig.Builder`	`setControllerNumber(int controllerNumber)` Sets the controller number (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setIdleState(int idleState)` Sets the idle output state (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setOutputBufferSize(int outputBufferSize)` Sets the requested output buffer size (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setOutputConfig(GPIOPinConfig outputConfig)` Sets the configuration of the output (a GPIO output pin) on which the pulses are to be generated (default value is `null` if not set).
`PWMChannelConfig.Builder`	`setPulseAlignment(int pulseAlignment)` Sets the pulse alignment - the alignment of the pulse within the pulse period (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setPulsePeriod(int pulsePeriod)` Sets the initial scaled output sampling interval (default value is `UNASSIGNED` if not set).
`PWMChannelConfig.Builder`	`setScaleFactor(double scaleFactor)` Sets the initial pulse period scale factor (default value is `1.0` if not set).

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

- Constructor Detail
  - PWMChannelConfig.Builder
```
public PWMChannelConfig.Builder()
```
    Creates a new Builder instance.
- Method Detail
  - build
```
public PWMChannelConfig build()
```
    Creates a new PWMChannelConfig instance initialized with the values set for each configuration parameters. If a configuration parameter was not explictly set its default value will be used.
    
    Returns:
    a new initialized PWMChannelConfig instance.
  - setControllerName
```
public PWMChannelConfig.Builder setControllerName(java.lang.String controllerName)
```
    Sets the controller name (default value is null if not set).
    
    Parameters:
    controllerName - the controller name (such as its device file name on UNIX systems) or null.
    
    Returns:
    this Builder instance.
  - setChannelNumber
```
public PWMChannelConfig.Builder setChannelNumber(int channelNumber)
```
    Sets the channel number (default value is UNASSIGNED if not set).
    
    Parameters:
    channelNumber - the channel number (a positive or zero integer) or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if channelNumber is not in the defined range.
  - setControllerNumber
```
public PWMChannelConfig.Builder setControllerNumber(int controllerNumber)
```
    Sets the controller number (default value is UNASSIGNED if not set).
    
    Parameters:
    controllerNumber - the hardware converter's number (a positive or zero integer) or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if controllerNumber is not in the defined range.
  - setOutputConfig
```
public PWMChannelConfig.Builder setOutputConfig(GPIOPinConfig outputConfig)
```
    Sets the configuration of the output (a GPIO output pin) on which the pulses are to be generated (default value is null if not set).
    
    Parameters:
    outputConfig - the configuration of the output (a GPIO output pin); or null if the output is implicit.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if outputConfig is not null and outputConfig's direction is not set to GPIOPinConfig.DIR_OUTPUT_ONLY or GPIOPinConfig.DIR_BOTH_INIT_OUTPUT.
  - setIdleState
```
public PWMChannelConfig.Builder setIdleState(int idleState)
```
    Sets the idle output state (default value is UNASSIGNED if not set).
    
    Parameters:
    idleState - the idle output state: : PWMChannelConfig.IDLE_STATE_HIGH, PWMChannelConfig.IDLE_STATE_LOW or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if idleState is not in the defined range.
  - setPulsePeriod
```
public PWMChannelConfig.Builder setPulsePeriod(int pulsePeriod)
```
    Sets the initial scaled output sampling interval (default value is UNASSIGNED if not set).
    
    Parameters:
    pulsePeriod - the initial scaled output sampling interval (the amount of time between two samples) in microseconds (a positive integer) or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if pulsePeriod is not in the defined range.
    See Also:
    setScaleFactor(double)
  - setScaleFactor
```
public PWMChannelConfig.Builder setScaleFactor(double scaleFactor)
```
    Sets the initial pulse period scale factor (default value is 1.0 if not set).
    
    Parameters:
    scaleFactor - the sampling time and sampling interval scale factor (a number greater or equal to 1.0).
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if scaleFactor is NaN or is less than 1.0.
  - setPulseAlignment
```
public PWMChannelConfig.Builder setPulseAlignment(int pulseAlignment)
```
    Sets the pulse alignment - the alignment of the pulse within the pulse period (default value is UNASSIGNED if not set).
    
    Parameters:
    pulseAlignment - the pulse alignment: PWMChannelConfig.ALIGN_CENTER, PWMChannelConfig.ALIGN_LEFT, PWMChannelConfig.ALIGN_RIGHT or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if pulseAlignment is not in the defined range.
  - setOutputBufferSize
```
public PWMChannelConfig.Builder setOutputBufferSize(int outputBufferSize)
```
    Sets the requested output buffer size (default value is UNASSIGNED if not set).
    
    Parameters:
    outputBufferSize - the requested output buffer size in number of samples (a positive or zero integer) or UNASSIGNED.
    
    Returns:
    this Builder instance.
    
    Throws:
    
    java.lang.IllegalArgumentException - if outputBufferSize is not in the defined range.

Class PWMChannelConfig.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PWMChannelConfig.Builder

Method Detail

build

setControllerName

setChannelNumber

setControllerNumber

setOutputConfig

setIdleState

setPulsePeriod

setScaleFactor

setPulseAlignment

setOutputBufferSize