Class AnalogInputChannel
Represents an analog HBM input channel.
Inheritance
Implements
Inherited Members
Namespace: Loehnert.Lisrt.Hbm
Assembly: Loehnert.Lisrt.Hbm.dll
Syntax
public class AnalogInputChannel : CompositeModule, INotifyPropertyChangedEx, ICompositeModule, ILisrtModule, INotifyPropertyChanged, IInputChannel, IAnalogInput, IHasKey, IHasDescription, IDisposable
Constructors
AnalogInputChannel(String, AnalogInChannel, Device)
Initializes a new instance of the AnalogInputChannel class.
Declaration
public AnalogInputChannel(string name, AnalogInChannel channel, Device device)
Parameters
Type | Name | Description |
---|---|---|
String | name | Name for the input. |
Hbm.Api.Common.Entities.Channels.AnalogInChannel | channel | HBM driver channel. |
Hbm.Api.Common.Entities.Device | device | HBM driver device. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when |
System.ArgumentNullException | Thrown when |
Properties
Calibration
Gets or sets the calibration.
Declaration
public ICalibration Calibration { get; set; }
Property Value
Type | Description |
---|---|
Loehnert.IO.Contracts.ICalibration |
Description
Gets a translatable description.
Declaration
public ITranslation Description { get; }
Property Value
Type | Description |
---|---|
Gu.Localization.ITranslation |
IsMeasuring
Gets a value indicating whether the channel is measuring.
Declaration
public bool IsMeasuring { get; }
Property Value
Type | Description |
---|---|
Boolean |
Key
Gets the key.
Declaration
public string Key { get; }
Property Value
Type | Description |
---|---|
String |
MeasureValuesUpdateInterval
Gets or sets the interval for updating the measure values for the channels. Default is 100ms.
Declaration
public double MeasureValuesUpdateInterval { get; set; }
Property Value
Type | Description |
---|---|
Double |
SampleRate
Gets the sample rate.
Declaration
public int SampleRate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Sensor
Gets or sets the sensor.
Declaration
public ISensor Sensor { get; set; }
Property Value
Type | Description |
---|---|
ISensor |
SignalName
Gets the signal name.
Declaration
public string SignalName { get; }
Property Value
Type | Description |
---|---|
String |
Value
Gets the value.
Declaration
public double Value { get; }
Property Value
Type | Description |
---|---|
Double |
Waveform
Gets the latest waveform.
Declaration
public IWaveform Waveform { get; }
Property Value
Type | Description |
---|---|
IWaveform |
XUnit
Gets or sets the x unit (usually 'ms').
Declaration
public string XUnit { get; set; }
Property Value
Type | Description |
---|---|
String |
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
GetValue()
Gets the value from the sensor.
Declaration
public double GetValue()
Returns
Type | Description |
---|---|
Double | The sensor value. |
GetWaveform()
Gets the waveform from the sensor.
Declaration
public IWaveform GetWaveform()
Returns
Type | Description |
---|---|
IWaveform | The sensor waveform. |
SetZeroBalance()
Executes a zero balancing by computing a new offset, using the configured zero target.
Declaration
public void SetZeroBalance()
Exceptions
Type | Condition |
---|---|
IOException | Thrown when an error occurs. |
SetZeroBalance(Double)
Executes a zero balancing by computing a new offset, using the targetValue
.
Declaration
public void SetZeroBalance(double targetValue)
Parameters
Type | Name | Description |
---|---|---|
Double | targetValue | Zero balance target value. |
Exceptions
Type | Condition |
---|---|
IOException | Thrown when an error occurs. |