Reads from encoder inputs immediately.
Namespace:
Quanser.Hardware
Assembly:
Quanser.Hardware.Hil (in Quanser.Hardware.Hil.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Sub ReadEncoder ( _
channels As Integer(), _
counts As Integer() _
) |
C# |
---|
public void ReadEncoder(
int[] channels,
int[] counts
) |
Visual C++ |
---|
public:
void ReadEncoder(
array<int>^ channels,
array<int>^ counts
) |
JavaScript |
---|
function readEncoder(channels, counts); |
Parameters
- channels
- Type: array<
System..::.Int32
>[]()[]
An array containing the numbers of the encoder input channels to be read.
Channel numbers are zero-based. Thus, channel 0 is the first channel, channel 1 the second channel, etc.
Select a board type from the list for board-specific details:
.
- counts
- Type: array<
System..::.Int32
>[]()[]
An array for receiving the count values read from the encoder inputs. Each element in
the counts array corresponds to the same element in the channels array.
Hence, there must be as many elements in the counts array as there are channels.
Remarks
Examples
This example illustrates how to read encoder inputs immediately. It reads encoder channels 0-3.
Exceptions are ignored for simplicity.
C# | Copy Code |
---|
int [] channels = { 0, 1, 2, 3 };
int [] buffer = new int [channels.Length];
card.ReadEncoder(channels, buffer);
|
Visual Basic | Copy Code |
---|
Dim channels() As Integer = {0, 1, 2, 3}
Dim buffer(channels.Length - 1) As Integer
card.ReadEncoder(channels, buffer)
|
Visual C++ | Copy Code |
---|
array<int>^ channels = { 0, 1, 2, 3 };
array<int>^ buffer = gcnew array<int>(channels->Length);
card->ReadEncoder(channels, buffer);
|
Exceptions
Exception | Condition |
---|
Quanser.Hardware..::.HilException |
If the read cannot be performed then an exception is thrown. This situtation
typically arises if the board does not support encoder inputs or the hardware
resources required are in use by a task.
|
See Also