Assembly: Quanser.Hardware.Hil (in Quanser.Hardware.Hil.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Class Hil _ Implements IDisposable |
C# |
---|
public class Hil : IDisposable |
Visual C++ |
---|
public ref class Hil : IDisposable |
JavaScript |
---|
Quanser.Hardware.Hil = function(); Type.createClass( 'Quanser.Hardware.Hil', null, IDisposable); |
Remarks
The Hil class is the starting point for accessing hardware using the Quanser .NET Class Library. Create a Hil object to begin accessing a particular data acquisition card. If the default constructor is used to initialize the object then the Open(String) or Open(String, String) method must be called to open a specific data acquisition card.
Data acquisition cards are identified by the type of card and a card identifier. The card type is denoted by a string, such as "q8", which corresponds to a particular kind of card. In this case, "q8" refers to the Quanser Q8 card.
The card identifier is also a string. It distinguishes between more than one card of the same type in the system. For example, if you have two Quanser Q8 cards in your system then the first card would be identified by "0" and the second card by an identifier of "1". Card identifiers are typically the numbers "0", "1", "2", etc. as strings. In this case the first card is always denoted by "0". Some cards also support symbolic names such as "Dev1". The National Instruments cards allow symbolic card identifiers which are set using Measurment and Automation Explorer.
Hardware access under the Quanser .NET Class Library may be categorized into several categories:
Category | Description |
---|---|
Configuration Methods | The configuration I/O methods are used to configure specific features or functionality of the data acquisition card, such as programming the directions of bi-directional digital I/O lines. |
Properties | The properties methods are used for getting information about the card or setting properties of the card. Properties are designed for features that may be queried or reconfigured repeatedly, but not frequently, during the course of operation. |
Immediate I/O | The immediate I/O methods read or write a single sample immediately, where a sample consists of any number of I/O channels on the card. |
Buffered I/O | The buffered I/O methods read or write a number of samples at a fixed rate. |
Task-Based I/O | The task methods are used to create an asynchronous task that may be used to read or write any number of samples at a fixed rate in the background, allowing other operations to be done in the foreground. |
Watchdog Methods | The watchdog methods allow a timer on the data acquisition card to be used as a hardware watchdog, resetting the outputs of the card if the timer is allowed to expire. |
The configuration methods are:
The properties methods are:
Method Name | Description |
---|---|
GetIntegerProperty(array<Hil..::.IntegerProperty>[]()[], array<Int32>[]()[]) | Gets the values of integer properties of the board. |
GetDoubleProperty(array<Hil..::.DoubleProperty>[]()[], array<Double>[]()[]) | Gets the values of double properties of the board. |
GetStringProperty(Hil..::.StringProperty) | Gets the value of a string property of the board. |
SetIntegerProperty(array<Hil..::.IntegerProperty>[]()[], array<Int32>[]()[]) | Sets the values of integer properties of the board. |
SetDoubleProperty(array<Hil..::.DoubleProperty>[]()[], array<Double>[]()[]) | Sets the values of double properties of the board. |
SetStringProperty(Hil..::.StringProperty, String) | Sets the value of a string property of the board. |
The immediate I/O methods are:
The buffered I/O methods are:
The task methods are:
The watchdog methods are:
Method Name | Description |
---|---|
WatchdogSetAnalogExpirationState(array<Int32>[]()[], array<Double>[]()[]) | Sets the state to which analog outputs will be set if the watchdog is allowed to expire. |
WatchdogSetPwmExpirationState(array<Int32>[]()[], array<Double>[]()[]) | Sets the state to which PWM outputs will be set if the watchdog is allowed to expire. |
WatchdogSetDigitalExpirationState(array<Int32>[]()[], array<Hil..::.DigitalState>[]()[]) | Sets the state to which digital outputs will be set if the watchdog is allowed to expire. |
WatchdogSetOtherExpirationState(array<Int32>[]()[], array<Double>[]()[]) | Sets the state to which other outputs will be set if the watchdog is allowed to expire. |
WatchdogStart(Double) | Starts the watchdog timer. |
WatchdogReload()()() | Reloads the watchdog timer to prevent it from expiring. |
WatchdogIsExpired()()() | Checks whether the watchdog timer has expired. |
WatchdogClear()()() | Clears the watchdog state so that I/O may be resumed on the card. |
WatchdogStop()()() | Stops or disables the watchdog timer. |
The interrupt methods are:
Method Name | Description |
---|---|
PollInterrupt(array<Int32>[]()[], array<SByte>[]()[]) | Queries the current states of interrupt sources on a card. |
MonitorCreateInterruptReader(array<Int32>[]()[]) | Creates a monitor for reading the states of interrupt sources on a card. |
MonitorStopAll()()() | Stops all monitors associated with this hardware instance. |
Inheritance Hierarchy
Quanser.Hardware..::.Hil