public class PulseCounterConfig extends java.lang.Object implements PeripheralConfig
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 PeripheralConfig.DEFAULT
.
Whether such default settings are supported is platform- as well as peripheral driver-dependent.
An instance of PulseCounterConfig
can be passed to the PeripheralManager.open(PeripheralConfig)
or
PeripheralManager.open(Class, PeripheralConfig)
method to open the designated counter with the specified
configuration. A PeripheralConfigInvalidException
is thrown when attempting to open a peripheral device with
an invalid or unsupported configuration.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).
|
DEFAULT
Constructor and Description |
---|
PulseCounterConfig(int counterNumber,
int type)
Creates a new
PulseCounterConfig with the specified hardware addressing information and type. |
PulseCounterConfig(int counterNumber,
int type,
GPIOPinConfig source)
Creates a new
PulseCounterConfig the specified hardware addressing information, type and GPIO pin source. |
Modifier and Type | Method and Description |
---|---|
int |
getCounterNumber()
Gets the configured counter number.
|
GPIOPinConfig |
getSource()
Gets the configured input source on which the pulses are to be counted/measured.
|
int |
getType()
Gets the configured pulse or pulse edge type.
|
public static final int TYPE_FALLING_EDGE_ONLY
public static final int TYPE_NEGATIVE_PULSE
public static final int TYPE_POSITIVE_PULSE
public static final int TYPE_RISING_EDGE_ONLY
public PulseCounterConfig(int counterNumber, int type)
PulseCounterConfig
with the specified hardware addressing information and type. The source
of the pulse counter is implicit (such as a dedicated input pin).counterNumber
- the hardware counter's number (a positive or null integer) or PeripheralConfig.DEFAULT
.type
- the pulse or pulse edge type: TYPE_FALLING_EDGE_ONLY
, TYPE_RISING_EDGE_ONLY
,
TYPE_NEGATIVE_PULSE
or TYPE_POSITIVE_PULSE
.java.lang.IllegalArgumentException
- if any of the following is true:
counterNumber
is not in the defined range;type
is not one of the defined values.public PulseCounterConfig(int counterNumber, int type, GPIOPinConfig source)
PulseCounterConfig
the specified hardware addressing information, type and GPIO pin source.counterNumber
- the hardware counter's number (a positive or null integer) or PeripheralConfig.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.java.lang.IllegalArgumentException
- if any of the following is true:
counterNumber
is not in the defined range;type
is not one of the defined values;java.lang.NullPointerException
- if source
is null
.public int getCounterNumber()
PeripheralConfig.DEFAULT
.public GPIOPinConfig getSource()
null
if the source is implicit.public int getType()
TYPE_FALLING_EDGE_ONLY
, TYPE_RISING_EDGE_ONLY
,
TYPE_NEGATIVE_PULSE
or TYPE_POSITIVE_PULSE
.Copyright (c) 1990, 2013, Oracle and/or its affiliates. All rights reserved.