com.oracle.deviceaccess.dac

Class DACChannelConfig

java.lang.Object

com.oracle.deviceaccess.dac.DACChannelConfig

All Implemented Interfaces:

PeripheralConfig<DACChannel>, PeripheralConfig.HardwareAddressing

public final class DACChannelConfig
extends java.lang.Object
implements PeripheralConfig<DACChannel>, PeripheralConfig.HardwareAddressing

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

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 DACChannelConfig can be passed to the PeripheralManager.open(PeripheralConfig) or PeripheralManager.open(Class, PeripheralConfig) method to open the designated DAC channel with the specified configuration. A PeripheralConfigInvalidException is thrown when attempting to open a peripheral device with an invalid or unsupported configuration.

See Also:

PeripheralManager.open(PeripheralConfig), PeripheralManager.open(Class, PeripheralConfig)

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.deviceaccess.PeripheralConfig

PeripheralConfig.HardwareAddressing

Field Summary

Fields inherited from interface com.oracle.deviceaccess.PeripheralConfig

DEFAULT

Constructor Summary

Constructors

Constructor and Description
DACChannelConfig(int deviceNumber, int channelNumber, int resolution, int samplingInterval) Creates a new DACChannelConfig with the specified hardware addressing information and configuration parameters.
DACChannelConfig(java.lang.String deviceName, int channelNumber, int resolution, int samplingInterval) Creates a new DACChannelConfig 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 DACChannelConfig objects for equality.
int	getChannelNumber() Gets the configured channel number.
java.lang.String	getDeviceName() Gets the configured device name (such as to its device file name on UNIX systems).
int	getDeviceNumber() Gets the configured device number.
int	getResolution() Gets the configured resolution.
int	getSamplingInterval() Gets the default/initial configured output sampling interval (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

DACChannelConfig

public DACChannelConfig(int deviceNumber,
                int channelNumber,
                int resolution,
                int samplingInterval)

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

Parameters:

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

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

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

samplingInterval - the initial output sampling interval in microseconds (a positive integer) or PeripheralConfig.DEFAULT.

Throws:

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

• deviceNumber 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.

DACChannelConfig

public DACChannelConfig(java.lang.String deviceName,
                int channelNumber,
                int resolution,
                int samplingInterval)

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

Parameters:

deviceName - the device name (such as to its device file name on UNIX systems).

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

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

samplingInterval - the initial output sampling interval in microseconds (a positive integer) or PeripheralConfig.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.

java.lang.NullPointerException - if deviceName 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 PeripheralConfig.DEFAULT.

getDeviceNumber

public int getDeviceNumber()

Gets the configured device number.

Specified by:

getDeviceNumber in interface PeripheralConfig.HardwareAddressing

Returns:

the hardware converter's number (a positive or zero integer) or PeripheralConfig.DEFAULT.

getDeviceName

public java.lang.String getDeviceName()

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

Specified by:

getDeviceName in interface PeripheralConfig.HardwareAddressing

Returns:

the deviceName or null.

getResolution

public int getResolution()

Gets the configured resolution.

Returns:

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

getSamplingInterval

public int getSamplingInterval()

Gets the default/initial configured output sampling interval (in microseconds).

Returns:

the default/initial output sampling interval in microseconds (a positive integer) or PeripheralConfig.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 DACChannelConfig 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 DACChannelConfig and has the same hardware addressing information and configuration parameter values as this DACChannelConfig object.