ICalibration.GetCalibration Method

Download PDF

Updated2023-02-21
3 minute(s) read

Reads the current calibration settings for a channel.

Namespace: NationalInstruments.VeriStand.ClientAPI
Assembly: NationalInstruments.VeriStand.ClientAPI (in NationalInstruments.VeriStand.ClientAPI.dll) Version: 2013.0.0.0 (2013.0.0.0)

Visual Basic (Declaration)
Function GetCalibration ( _ channelName As String, _ <OutAttribute> ByRef scaleType As ScaleType, _ <OutAttribute> ByRef coefficients As Double(), _ <OutAttribute> ByRef thermocoupleType As ThermocoupleType, _ <OutAttribute> ByRef units As TemperatureUnits, _ <OutAttribute> ByRef cjcType As CJCType, _ <OutAttribute> ByRef cjcChannelName As String, _ <OutAttribute> ByRef offset As Double, _ <OutAttribute> ByRef scale As Double _ ) As Error

Visual Basic (Declaration)

Function GetCalibration ( _
	channelName As String, _
	<OutAttribute> ByRef scaleType As ScaleType, _
	<OutAttribute> ByRef coefficients As Double(), _
	<OutAttribute> ByRef thermocoupleType As ThermocoupleType, _
	<OutAttribute> ByRef units As TemperatureUnits, _
	<OutAttribute> ByRef cjcType As CJCType, _
	<OutAttribute> ByRef cjcChannelName As String, _
	<OutAttribute> ByRef offset As Double, _
	<OutAttribute> ByRef scale As Double _
) As Error

C#
Error GetCalibration( string channelName, out ScaleType scaleType, out double[] coefficients, out ThermocoupleType thermocoupleType, out TemperatureUnits units, out CJCType cjcType, out string cjcChannelName, out double offset, out double scale )

Error GetCalibration(
	string channelName,
	out ScaleType scaleType,
	out double[] coefficients,
	out ThermocoupleType thermocoupleType,
	out TemperatureUnits units,
	out CJCType cjcType,
	out string cjcChannelName,
	out double offset,
	out double scale
)

Visual C++
Error^ GetCalibration( String^ channelName, [OutAttribute] ScaleType% scaleType, [OutAttribute] array<double>^% coefficients, [OutAttribute] ThermocoupleType% thermocoupleType, [OutAttribute] TemperatureUnits% units, [OutAttribute] CJCType% cjcType, [OutAttribute] String^% cjcChannelName, [OutAttribute] double% offset, [OutAttribute] double% scale )

Visual C++

Error^ GetCalibration(
	String^ channelName, 
	[OutAttribute] ScaleType% scaleType, 
	[OutAttribute] array<double>^% coefficients, 
	[OutAttribute] ThermocoupleType% thermocoupleType, 
	[OutAttribute] TemperatureUnits% units, 
	[OutAttribute] CJCType% cjcType, 
	[OutAttribute] String^% cjcChannelName, 
	[OutAttribute] double% offset, 
	[OutAttribute] double% scale
)

Parameters

channelName: Type: System.String
The name of the channel from which to get calibration information.

scaleType: Type: NationalInstruments.VeriStand.ClientAPI.ScaleType %
The ScaleType of the calibration scale.

coefficients: Type: System.Double %
The coefficients of the polynomial scale. (Valid only if ScaleType is 0—Polynomial.)

thermocoupleType: Type: NationalInstruments.VeriStand.ClientAPI.ThermocoupleType %
The ThermocoupleType. (Valid only if ScaleType is 1—Thermocouple.)

units: Type: NationalInstruments.VeriStand.ClientAPI.TemperatureUnits %
The TemperatureUnits of the calibrated value. (Valid only if ScaleType is 1—Thermocouple.)

cjcType: Type: NationalInstruments.VeriStand.ClientAPI.CJCType %
The CJCType of the cold junction compensation sensor. (Valid only if ScaleType is 1—Thermocouple.)

cjcChannelName: Type: System.String %
The name of the cold junction compensation channel. (Valid only if ScaleType is 1—Thermocouple.)

offset: Type: System.Double %
The offset applied after primary scaling.

scale: Type: System.Double %
The scale applied after primary scaling.

Return Value

Returns an error if the calibration component is not available or if the channel is not scalable. If no error occurs, the Code property of the Error object is 0.

VeriStand .NET API Reference

Table of Contents

ICalibration.GetCalibration Method

Parameters

Return Value

See Also

Reference

Log in to get a better experience