Gets the values of double properties of the board.
Namespace:
Quanser.Hardware
Assembly:
Quanser.Hardware.Hil (in Quanser.Hardware.Hil.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Sub GetDoubleProperty ( _
properties As Hil..::.DoubleProperty(), _
values As Double() _
) |
JavaScript |
---|
function getDoubleProperty(properties, values); |
Parameters
- properties
- Type: array<
Quanser.Hardware..::.Hil..::.DoubleProperty
>[]()[]
An array containing the property numbers of the properties to be retrieved. For a list of the standard double properties refer
to the Hil..::.DoubleProperty enumeration. Boards may have custom properties as well.
Select a board type from the list for board-specific details:
.
- values
- Type: array<
System..::.Double
>[]()[]
An array for receiving the property values retrieved from the board. Each element in
the values array corresponds to the same element in the properties array.
Hence, there must be as many elements in the values array as there are properties.
Remarks
Examples
This sample illustrates how to use the
GetDoubleProperty(array<Hil..::.DoubleProperty>[]()[], array<Double>[]()[]) method.
It reads a custom property of the board.
C# | Copy Code |
---|
Hil.DoubleProperty [] properties = { Hil.DoubleProperty.ProductSpecific + 5 };
double [] values = new double [properties.Length];
board.GetDoubleProperty(properties, values);
Console.WriteLine("Value: " + values[0]);
|
Visual Basic | Copy Code |
---|
Dim properties() As Hil.DoubleProperty = {Hil.DoubleProperty.ProductSpecific + 5}
Dim values(properties.Length - 1) As Double
board.GetDoubleProperty(properties, values)
Console.WriteLine("Value: " & values(0))
|
Visual C++ | Copy Code |
---|
array<Hil::DoubleProperty>^ properties = { Hil::DoubleProperty::ProductSpecific + (Hil::DoubleProperty) 5 };
array<double>^ values = gcnew array<double>(properties->Length);
board->GetDoubleProperty(properties, values);
Console::WriteLine(L"Value: " + values[0]);
|
Exceptions
Exception | Condition |
---|
Quanser.Hardware..::.HilException |
If the property values cannot be retrieved then an exception is thrown. This situtation
typically arises when one of the properties is not supported by the board.
|
See Also