public class LucidControlRT4
extends java.lang.Object
This class encapsulates the LucidControl RT4 RTD Input USB Module functionality.
Modifier and Type | Class and Description |
---|---|
static class |
LucidControlRT4.DeviceType
Device type enumeration
|
static class |
LucidControlRT4.LCRT4CalMode
RT4 module Calibration Modes
|
static class |
LucidControlRT4.LCRT4Mode
RT4 module Operation Modes
|
Constructor and Description |
---|
LucidControlRT4(java.lang.String portName) |
Modifier and Type | Method and Description |
---|---|
IoReturn |
calibrateIo(int channel,
boolean persistent,
LucidControlRT4.LCRT4CalMode calMode)
Performs calibration of the RTD input channel.
|
boolean |
close() |
java.lang.String |
getDeviceClassName() |
int |
getDeviceSnr() |
IoReturn |
getIo(int channel,
ValueRMU2 value)
Get the Resistance value of the RTD input channel.
|
IoReturn |
getIo(int channel,
ValueTMS2 value)
Get the Temperature value of the RTD input channel.
|
IoReturn |
getIo(int channel,
ValueTMS4 value)
Get the Temperature value of the RTD input channel.
|
IoReturn |
getIoGroup(boolean[] channels,
ValueRMU2[] values)
Get the Resistance values of a group of RTD input channels.
|
IoReturn |
getIoGroup(boolean[] channels,
ValueTMS2[] values)
Get the Temperature values of a group of RTD input channels.
|
IoReturn |
getIoGroup(boolean[] channels,
ValueTMS4[] values)
Get the Temperature values of a group of RTD input channels.
|
IoReturn |
getParamCalUm(int channel,
int[] calUm)
Get the Configuration Parameter "CalUm" of the RTD input channel.
|
IoReturn |
getParamCalUrs(int channel,
short[] calUrs)
Get the Configuration Parameter "CalUrs" of the RTD input channel.
|
IoReturn |
getParamMode(int channel,
LucidControlRT4.LCRT4Mode[] mode)
Get the Configuration Parameter "Mode" of the RTD input channel.
|
IoReturn |
getParamOffset(int channel,
short[] offset)
Get the Configuration Parameter "Offset" of the RTD input channel.
|
IoReturn |
getParamScanInterval(int channel,
int[] scanInterval)
Get the Configuration Parameter "Scan Interval" of the RTD input channel.
|
IoReturn |
getParamSetupTime(int channel,
int[] setupTime)
Get the Configuration Parameter "Setup Time" of the RTD input channel.
|
IoReturn |
getParamValue(int channel,
ValueRMU2 value)
Get the Configuration Parameter "Value" of a RTD input channel.
|
int |
getRevisionFw() |
short |
getRevisionHw() |
IoReturn |
identify(int options) |
boolean |
isOpened() |
boolean |
open() |
IoReturn |
setParamCalUm(int channel,
boolean persistent)
Set the Configuration Parameter "CalUm" of the RTD input channel to the
default value.
|
IoReturn |
setParamCalUm(int channel,
boolean persistent,
int calUm)
Set the Configuration Parameter "CalUm" of the RTD input channel.
|
IoReturn |
setParamCalUrs(int channel,
boolean persistent)
Set the Configuration Parameter "CalUrs" of the RTD input channel to the
default value.
|
IoReturn |
setParamCalUrs(int channel,
boolean persistent,
short calUrs)
Set the Configuration Parameter "CalUrs" of the RTD input channel.
|
IoReturn |
setParamFlags(int channel,
boolean persistent)
Set the Configuration Parameter "Flags" of the RTD input channel to the default
value.
|
IoReturn |
setParamMode(int channel,
boolean persistent)
Set the Configuration Parameter "Mode" of the RTD input channel to the
default value.
|
IoReturn |
setParamMode(int channel,
boolean persistent,
LucidControlRT4.LCRT4Mode mode)
Set the Configuration Parameter "Mode" of the RTD input channel.
|
IoReturn |
setParamOffset(int channel,
boolean persistent)
Set the Configuration Parameter "Offset" of the RTD input channel to the
default value.
|
IoReturn |
setParamOffset(int channel,
boolean persistent,
short offset)
Set the Configuration Parameter "Offset" of the RTD input channel.
|
IoReturn |
setParamScanInterval(int channel,
boolean persistent)
Set the Configuration Parameter "Scan Interval" of the RTD input channel to the
default value.
|
IoReturn |
setParamScanInterval(int channel,
boolean persistent,
int scanInterval)
Set the Configuration Parameter "Scan Interval" of the RTD input channel.
|
IoReturn |
setParamSetupTime(int channel,
boolean persistent)
Set the Configuration Parameter "Setup Time" of the RTD input channel to the
default value.
|
IoReturn |
setParamSetupTime(int channel,
boolean persistent,
int setupTime)
Set the Configuration Parameter "Setup Time" of the RTD input channel.
|
void |
setPortName(java.lang.String portName) |
public IoReturn getIo(int channel, ValueRMU2 value) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Resistance value of the RTD input channel.
This method calls the GetIo function of the module and returns the measured resistance of the RTD (Resistance Temperature Detector) input channel with 0.1 Ohm resolution.
The Resistance value might not be what you are looking for. Please see the
other getIo functions with ValueTMS2
and ValueTMS4
value types
for temperature measurements.
channel
- RTD input channel to read from. Must be in the range 0 ... 3value
- Resistance value objectIoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getIo(int channel, ValueTMS2 value) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Temperature value of the RTD input channel.
This method calls the GetIo function of the module and returns the measured temperature of the RTD (Resistance Temperature Detector) input channel with 0.1K resolution.
This method uses Value Type TMS2 of the module. Please consider using the
getIo function with ValueTMS4
parameter for 0.01K resolution.
channel
- RTD input channel to read from. Must be in the range 0 ... 3value
- Temperature value objectIoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getIo(int channel, ValueTMS4 value) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Temperature value of the RTD input channel.
This method calls the GetIo function of the module and returns the measured temperature of the RTD (Resistance Temperature Detector) input channel with 0.01K resolution.
channel
- RTD input channel to read from. Must be in the range 0 ... 3value
- Temperature value objectIoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getIoGroup(boolean[] channels, ValueRMU2[] values) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Resistance values of a group of RTD input channels.
This method calls the GetIoGroup function of the module and returns the Resistance values of a group of RTD (Resistance Temperature Detector) input channels.
The Resistance value might not be what you are looking for. Please see the
other getIoGroup functions with ValueTMS2
and ValueTMS4
value types
for temperature measurements.
channels
- Get channel array.
Boolean array with 4 values (one for each channel). A channel is only read in the case that the corresponding channel array value is true.
values
- Resistance value object array.
Empty array prepared for 4 Temperature value objects. The function fills the array with the read value data.
Value objects are only updated in the case that the corresponding channel in the channel array is set to true.
IoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getIoGroup(boolean[] channels, ValueTMS2[] values) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Temperature values of a group of RTD input channels.
This method calls the GetIoGroup function of the module and returns the Temperature values of a group of RTD (Resistance Temperature Detector) input channels with a resolution of 0.1K.
This method uses Value Type TMS2 of the module. Please consider using the
getIoGetGroup function with ValueTMS4
parameter for 0.01K resolution.
channels
- Get channel array.
Boolean array with 4 values (one for each channel). A channel is only read in the case that the corresponding channel array value is true.
values
- Temperature value object array.
Empty array prepared for 4 Temperature value objects. The function fills the array with the read value data.
Value objects are only updated in the case that the corresponding channel in the channel array is set to true.
IoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getIoGroup(boolean[] channels, ValueTMS4[] values) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Temperature values of a group of RTD input channels.
This method calls the GetIoGroup function of the module and returns the Temperature values of a group of RTD (Resistance Temperature Detector) input channels with a resolution of 0.01K.
channels
- Get channel array.
Boolean array with 4 values (one for each channel). A channel is only read in the case that the corresponding channel array value is true.
values
- Temperature value object array.
Empty array prepared for 4 Temperature value objects. The function fills the array with the read value data.
Value objects are only updated in the case that the corresponding channel in the channel array is set to true.
IoReturn
java.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn calibrateIo(int channel, boolean persistent, LucidControlRT4.LCRT4CalMode calMode) throws java.lang.IllegalArgumentException, java.io.IOException
Performs calibration of the RTD input channel.
This method calls the CalibrateIo function of the module.
channel
- RTD channel to calibratecalMode
- Calibration modepersistent
- It this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamValue(int channel, ValueRMU2 value) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "Value" of a RTD input channel.
This method calls the GetParam function of the module and returns the value of the Configuration Parameter "Value".
The Configuration Parameter "Value" contains the measured Resistance value of the RTD input channel. It is recommended to call getIo instead of this method.
channel
- Channel to read parameter from. Must be in the range 0 ... 3value
- Resistance value objectIoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn getParamMode(int channel, LucidControlRT4.LCRT4Mode[] mode) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "Mode" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "Mode".
The Configuration Parameter "Mode" represents the current operation mode of the RTD input channel.
channel
- Channel to read parameter from. Must be in the range 0 ... 3mode
- RTD input channel operation modeIoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamMode(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Mode" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "Mode" to its default value.
channel
- Channel to configure. Must be in the range 0 ... 3persistent
- It this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamMode(int channel, boolean persistent, LucidControlRT4.LCRT4Mode mode) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Mode" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "Mode".
The Configuration Parameter "Mode" represents the current operation mode of the RTD input channel.
channel
- Channel to configure. Must be in the range 0 ... 3persistent
- It this parameter is true the setting is stored permanently.mode
- Operation modeIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamFlags(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Flags" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "Flags" to its default value.
It is not possible to assign a value to the Configuration Parameter "Flags" directly.
Calling this method initializes all flag values with its default values.
channel
- Channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlyIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamScanInterval(int channel, int[] scanInterval) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "Scan Interval" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "Scan Interval".
channel
- RTD input channel. Must be in the range 0 ... 3scanInterval
- Configuration Parameter "Scan Interval" in millisecondsIoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamScanInterval(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Scan Interval" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "Scan Interval" to its default value.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamScanInterval(int channel, boolean persistent, int scanInterval) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Scan Interval" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "Scan Interval".
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlyscanInterval
- Scan Interval in millisecondsIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamSetupTime(int channel, int[] setupTime) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "Setup Time" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "Setup Time".
channel
- RTD input channel. Must be in the range 0 ... 3setupTime
- Configuration Parameter "Setup Time" in millisecondsIoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamSetupTime(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Setup Time" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "Setup Time" to its default value.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamSetupTime(int channel, boolean persistent, int setupTime) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Setup Time" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "Setup Time".
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlysetupTime
- Setup Time in millisecondsIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamOffset(int channel, short[] offset) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "Offset" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "Offset".
channel
- RTD input channel. Must be in the range 0 ... 3offset
- Configuration Parameter "Offset"IoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamOffset(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Offset" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "Offset" to its default value.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamOffset(int channel, boolean persistent, short offset) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "Offset" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "Offset".
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlyoffset
- Offset valueIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamCalUm(int channel, int[] calUm) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "CalUm" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "CalUm".
channel
- RTD input channel. Must be in the range 0 ... 3calUm
- Configuration Parameter "CalUm"IoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamCalUm(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "CalUm" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "CalUm" to its default value.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamCalUm(int channel, boolean persistent, int calUm) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "CalUm" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "CalUm".
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlycalUm
- Calibration Value CalUmIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn getParamCalUrs(int channel, short[] calUrs) throws java.lang.IllegalArgumentException, java.lang.NullPointerException, java.io.IOException
Get the Configuration Parameter "CalUrs" of the RTD input channel.
This method calls the GetParam function of the module and returns the Configuration Parameter "CalUrs".
channel
- RTD input channel. Must be in the range 0 ... 3calUrs
- Configuration Parameter "CalUrs"IoReturn
Valuejava.lang.IllegalArgumentException
java.lang.NullPointerException
java.io.IOException
public IoReturn setParamCalUrs(int channel, boolean persistent) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "CalUrs" of the RTD input channel to the default value.
This method calls the SetParam function of the module and sets the Configuration Parameter "CalUrs" to its default value.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanently.IoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public IoReturn setParamCalUrs(int channel, boolean persistent, short calUrs) throws java.lang.IllegalArgumentException, java.io.IOException
Set the Configuration Parameter "CalUrs" of the RTD input channel.
This method calls the SetParam function of the module and sets the Configuration Parameter "CalUrs.
channel
- RTD input channel to configure. Must be in the range 0 ... 3persistent
- If this parameter is true the setting is stored permanentlycalUrs
- Calibration Value CalUrsIoReturn
Valuejava.lang.IllegalArgumentException
java.io.IOException
public int getRevisionFw() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public short getRevisionHw() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public java.lang.String getDeviceClassName() throws java.lang.IllegalStateException
java.lang.IllegalStateException
public int getDeviceSnr()
public IoReturn identify(int options) throws java.io.IOException
java.io.IOException
public void setPortName(java.lang.String portName) throws java.lang.IllegalStateException
java.lang.IllegalStateException
public boolean isOpened()
public boolean open() throws java.io.IOException
java.io.IOException
public boolean close() throws java.io.IOException
java.io.IOException