jdk.dio.adc

Class ADCChannelConfig

java.lang.Object

jdk.dio.adc.ADCChannelConfig

All Implemented Interfaces:

DeviceConfig<ADCChannel>, DeviceConfig.HardwareAddressing

public final class ADCChannelConfig
extends java.lang.Object
implements DeviceConfig<ADCChannel>, DeviceConfig.HardwareAddressing

The ADCChannelConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of an ADC channel.

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 ADCChannelConfig can be passed to the DeviceManager.open(DeviceConfig) or DeviceManager.open(Class, DeviceConfig) method to open the designated ADC channel 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 inherited from interface jdk.dio.DeviceConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
ADCChannelConfig(int controllerNumber, int channelNumber, int resolution, int samplingInterval, int samplingTime) Creates a new ADCChannelConfig with the specified hardware addressing information and configuration parameters.
ADCChannelConfig(java.lang.String controllerName, int channelNumber, int resolution, int samplingInterval, int samplingTime) Creates a new ADCChannelConfig with the specified hardware addressing information and configuration parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Checks two ADCChannelConfig objects for equality.
int	getChannelNumber() Gets the configured channel number.
java.lang.String	getControllerName() Gets the configured controller name (such as its device file name on UNIX systems).
int	getControllerNumber() Gets the configured device number (such as the ADC converter number).
int	getResolution() Gets the configured resolution.
int	getSamplingInterval() Gets the configured default/initial input sampling interval - the amount of time between two samples (in microseconds).
int	getSamplingTime() Gets the configured input sampling time - the amount of time to take the sample (in microseconds).
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

Constructor Detail

ADCChannelConfig

public ADCChannelConfig(int controllerNumber,
                int channelNumber,
                int resolution,
                int samplingInterval,
                int samplingTime)

Creates a new ADCChannelConfig with the specified hardware addressing information and configuration parameters.

Parameters:

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

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

resolution - the resolution in bits (a positive integer) or DeviceConfig.DEFAULT.

samplingInterval - the initial input sampling interval (the amount of time between two samples) in microseconds (a positive integer) or DeviceConfig.DEFAULT.

samplingTime - the sampling time (the amount of time to take the sample) in microseconds (a positive integer) or DeviceConfig.DEFAULT.

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;
• resolution is not in the defined range;
• samplingInterval is not in the defined range;
• samplingTime is not in the defined range.

ADCChannelConfig

public ADCChannelConfig(java.lang.String controllerName,
                int channelNumber,
                int resolution,
                int samplingInterval,
                int samplingTime)

Creates a new ADCChannelConfig with the specified hardware addressing information and configuration parameters.

Parameters:

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

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

resolution - the resolution in bits (a positive integer) or DeviceConfig.DEFAULT.

samplingInterval - the initial input sampling interval (the amount of time between two samples) in microseconds (a positive integer) or DeviceConfig.DEFAULT.

samplingTime - the sampling time (the amount of time to take the sample) in microseconds (a positive integer) or DeviceConfig.DEFAULT.

Throws:

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

• channelNumber is not in the defined range;
• resolution is not in the defined range;
• samplingInterval is not in the defined range;
• samplingTime is not in the defined range.

java.lang.NullPointerException - if controllerName is null.

Method Detail

getChannelNumber

public int getChannelNumber()

Gets the configured channel number.

Returns:

the hardware channel's number (a positive or zero integer) or DeviceConfig.DEFAULT.

getControllerNumber

public int getControllerNumber()

Gets the configured device number (such as the ADC converter number).

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the device 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 controller name or null.

getResolution

public int getResolution()

Gets the configured resolution.

Returns:

the resolution in bits (a positive integer) or DeviceConfig.DEFAULT.

getSamplingInterval

public int getSamplingInterval()

Gets the configured default/initial input sampling interval - the amount of time between two samples (in microseconds).

Returns:

the default/initial input sampling interval in microseconds (a positive integer) or DeviceConfig.DEFAULT.

getSamplingTime

public int getSamplingTime()

Gets the configured input sampling time - the amount of time to take the sample (in microseconds).

Returns:

the input sampling time in microseconds (a positive integer) or DeviceConfig.DEFAULT.

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 ADCChannelConfig 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 ADCChannelConfig and has the same hardware addressing information and configuration parameter values as this ADCChannelConfig object.