jdk.dio.counter

Class PulseCounterConfig

java.lang.Object

jdk.dio.counter.PulseCounterConfig

All Implemented Interfaces:

DeviceConfig<PulseCounter>, DeviceConfig.HardwareAddressing

public class PulseCounterConfig
extends java.lang.Object
implements DeviceConfig<PulseCounter>, DeviceConfig.HardwareAddressing

The PulseCounterConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a pulse counter.

Some hardware addressing parameter, and static and dynamic configuration parameters may be set to DeviceConfig.DEFAULT. Whether such default settings are supported is platform- as well as device driver-dependent.

An instance of PulseCounterConfig can be passed to the DeviceManager.open(DeviceConfig) or DeviceManager.open(Class, DeviceConfig) method to open the designated counter with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

See Also:

DeviceManager.open(DeviceConfig), DeviceManager.open(Class, DeviceConfig)

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.dio.DeviceConfig

DeviceConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_FALLING_EDGE_ONLY Falling pulse edge (counting only falling pulse edges).
static int	TYPE_NEGATIVE_PULSE Negative edge pulse: measured from falling edge to rising edge (counting well-formed negative edge pulses).
static int	TYPE_POSITIVE_PULSE Positive edge pulse: measured from rising edge to falling edge (counting well-formed positive edge pulses).
static int	TYPE_RISING_EDGE_ONLY Rising pulse edge (counting only rising pulse edges).

Fields inherited from interface jdk.dio.DeviceConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
PulseCounterConfig(int controllerNumber, int channelNumber, int type) Creates a new PulseCounterConfig with the specified hardware addressing information and type.
PulseCounterConfig(int controllerNumber, int channelNumber, int type, GPIOPinConfig source) Creates a new PulseCounterConfig the specified hardware addressing information, type and GPIO pin source.
PulseCounterConfig(java.lang.String controllerName, int channelNumber, int type) Creates a new PulseCounterConfig with the specified hardware addressing information and type.
PulseCounterConfig(java.lang.String controllerName, int channelNumber, int type, GPIOPinConfig source) Creates a new PulseCounterConfig the specified hardware addressing information, type and GPIO pin source.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two PulseCounterConfig objects for equality.
int	getChannelNumber() Gets the configured counter number.
java.lang.String	getControllerName() Gets the configured controller name (such as its device file name on UNIX systems).
int	getControllerNumber() Gets the configured controller number.
GPIOPin	getSource() Gets the input source on which the pulses are to be counted/measured.
GPIOPinConfig	getSourceConfig() Gets the configured input source configuration on which the pulses are to be counted/measured.
int	getType() Gets the configured pulse or pulse edge type.
int	hashCode() Returns the hash code value for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_FALLING_EDGE_ONLY

public static final int TYPE_FALLING_EDGE_ONLY

Falling pulse edge (counting only falling pulse edges). When the pulse source is a GPIO pin then this pulse edge type can only be used if the pin is configured with the GPIOPinConfig.TRIGGER_FALLING_EDGE trigger mode.

See Also:

Constant Field Values

TYPE_NEGATIVE_PULSE

public static final int TYPE_NEGATIVE_PULSE

Negative edge pulse: measured from falling edge to rising edge (counting well-formed negative edge pulses). When the pulse source is a GPIO pin then this pulse edge type can only be used if the pin is configured with the GPIOPinConfig.TRIGGER_BOTH_EDGES trigger mode.

See Also:

Constant Field Values

TYPE_POSITIVE_PULSE

public static final int TYPE_POSITIVE_PULSE

Positive edge pulse: measured from rising edge to falling edge (counting well-formed positive edge pulses). When the pulse source is a GPIO pin then this pulse edge type can only be used if the pin is configured with the GPIOPinConfig.TRIGGER_BOTH_EDGES trigger mode.

See Also:

Constant Field Values

TYPE_RISING_EDGE_ONLY

public static final int TYPE_RISING_EDGE_ONLY

Rising pulse edge (counting only rising pulse edges). When the pulse source is a GPIO pin then this pulse edge type can only be used if the pin is configured with the GPIOPinConfig.TRIGGER_RISING_EDGE trigger mode.

See Also:

Constant Field Values

Constructor Detail

PulseCounterConfig

public PulseCounterConfig(int controllerNumber,
                  int channelNumber,
                  int type)

Creates a new PulseCounterConfig with the specified hardware addressing information and type. The source of the pulse counter is implicit (such as a dedicated input pin).

Parameters:

controllerNumber - the hardware controller's number (a positive or zero integer) or DeviceConfig.DEFAULT.

channelNumber - the hardware counter's number (a positive or zero integer) or DeviceConfig.DEFAULT.

type - the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY, TYPE_RISING_EDGE_ONLY, TYPE_NEGATIVE_PULSE or TYPE_POSITIVE_PULSE.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• controllerNumber is not in the defined range;
• channelNumber is not in the defined range;
• type is not one of the defined values.

PulseCounterConfig

public PulseCounterConfig(int controllerNumber,
                  int channelNumber,
                  int type,
                  GPIOPinConfig source)

Creates a new PulseCounterConfig the specified hardware addressing information, type and GPIO pin source.

Parameters:

controllerNumber - the hardware controller's number (a positive or zero integer) or DeviceConfig.DEFAULT.

channelNumber - the hardware counter's number (a positive or zero integer) or DeviceConfig.DEFAULT.

type - the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY, TYPE_RISING_EDGE_ONLY, TYPE_NEGATIVE_PULSE or TYPE_POSITIVE_PULSE.

source - the configuration of the source (a GPIO input pin) on which the pulses are to be counted.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• controllerNumber is not in the defined range;
• channelNumber is not in the defined range;
• type is not one of the defined values;
• if the provided source is not configured for input;
• if the provided source is not configured with an edge trigger mode compatible with the specified pulse type.

java.lang.NullPointerException - if source is null.

PulseCounterConfig

public PulseCounterConfig(java.lang.String controllerName,
                  int channelNumber,
                  int type)

Creates a new PulseCounterConfig with the specified hardware addressing information and type. The source of the pulse counter is implicit (such as a dedicated input pin).

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems).

channelNumber - the hardware counter's number (a positive or zero integer) or DeviceConfig.DEFAULT.

type - the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY, TYPE_RISING_EDGE_ONLY, TYPE_NEGATIVE_PULSE or TYPE_POSITIVE_PULSE.

Throws:

java.lang.NullPointerException - if controllerName is null.

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• type is not one of the defined values.

PulseCounterConfig

public PulseCounterConfig(java.lang.String controllerName,
                  int channelNumber,
                  int type,
                  GPIOPinConfig source)

Creates a new PulseCounterConfig the specified hardware addressing information, type and GPIO pin source.

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems).

channelNumber - the hardware counter's number (a positive or zero integer) or DeviceConfig.DEFAULT.

type - the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY, TYPE_RISING_EDGE_ONLY, TYPE_NEGATIVE_PULSE or TYPE_POSITIVE_PULSE.

source - the configuration of the source (a GPIO input pin) on which the pulses are to be counted.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• type is not one of the defined values;
• if the provided source is not configured for input;
• if the provided source is not configured with an edge trigger mode compatible with the specified pulse type.

java.lang.NullPointerException - if controllerName or source is null.

Method Detail

getControllerNumber

public int getControllerNumber()

Gets the configured controller number.

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the controller number (a positive or zero integer); or DeviceConfig.DEFAULT.

getChannelNumber

public int getChannelNumber()

Gets the configured counter number.

Returns:

the counter number (a positive or zero integer); or DeviceConfig.DEFAULT.

getControllerName

public java.lang.String getControllerName()

Gets the configured controller name (such as its device file name on UNIX systems).

Specified by:

getControllerName in interface DeviceConfig.HardwareAddressing

Returns:

the controllerName or null.

getSource

public GPIOPin getSource()

Gets the input source on which the pulses are to be counted/measured.

A concurrent runtime change of the dynamic configuration parameters of the source (such as of its direction) may result in IOException being thrown by counting operations.

Returns:

the source on which the pulses are to be counted/measured; or null if the source is implicit or if this PusleCounterConfig instance is not associated to an actual PulseCounter instance.

getSourceConfig

public GPIOPinConfig getSourceConfig()

Gets the configured input source configuration on which the pulses are to be counted/measured.

Returns:

the configuration of the source on which the pulses are to be counted/measured; or null if the source is implicit.

getType

public int getType()

Gets the configured pulse or pulse edge type.

Returns:

the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY, TYPE_RISING_EDGE_ONLY, TYPE_NEGATIVE_PULSE or TYPE_POSITIVE_PULSE.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Checks two PulseCounterConfig objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a PulseCounterConfig and has the same hardware addressing information and configuration parameter values as this PulseCounterConfig object.