NI-DAQmx .NET Framework 4.0 API Reference

Table of Contents

AIChannelCollection.CreateForceIepeChannel Method (String, String, AITerminalConfiguration, Double, Double, String, Double, AIForceIepeSensorSensitivityUnits, AIExcitationSource, Double)

  • Updated2023-02-21
  • 3 minute(s) read
AIChannelCollection.CreateForceIepeChannel Method (String, String, AITerminalConfiguration, Double, Double, String, Double, AIForceIepeSensorSensitivityUnits, AIExcitationSource, Double)
Creates an AIChannel that uses an IEPE force sensor to measure force or load, with the specified custom scale. This method adds one or more physical channels to the AIChannelCollection.

Namespace:  NationalInstruments.DAQmx
Assembly:  NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302

Syntax

public AIChannel CreateForceIepeChannel(
	string physicalChannelName,
	string nameToAssignChannel,
	AITerminalConfiguration terminalConfiguration,
	double minimumValue,
	double maximumValue,
	string customScaleName,
	double sensitivity,
	AIForceIepeSensorSensitivityUnits sensitivityUnits,
	AIExcitationSource currentExcitationSource,
	double currentExcitationValue
)
Public Function CreateForceIepeChannel ( 
	physicalChannelName As String,
	nameToAssignChannel As String,
	terminalConfiguration As AITerminalConfiguration,
	minimumValue As Double,
	maximumValue As Double,
	customScaleName As String,
	sensitivity As Double,
	sensitivityUnits As AIForceIepeSensorSensitivityUnits,
	currentExcitationSource As AIExcitationSource,
	currentExcitationValue As Double
) As AIChannel

Parameters

physicalChannelName
Type: SystemString
The names of one or more physical channels to use to create one or more local virtual channels.
nameToAssignChannel
Type: SystemString
One or more names to assign to the created local virtual channels. To use the physical channel name as the local virtual channel name, set this value to Empty.
terminalConfiguration
Type: NationalInstruments.DAQmxAITerminalConfiguration
The input terminal configuration. To use the default terminal configuration for the physical channel(s) being used, pass a value of 1 casted to an AITerminalConfiguration.
minimumValue
Type: SystemDouble
The minimum value you expect to measure, in units.
maximumValue
Type: SystemDouble
The maximum value you expect to measure, in units.
customScaleName
Type: SystemString
The name of the custom scale to apply to the local virtual channel.
sensitivity
Type: SystemDouble
The sensitivity of the sensor. This value is in the units you specify with sensitivityUnits. Refer to the sensor documentation to determine this value.
sensitivityUnits
Type: NationalInstruments.DAQmxAIForceIepeSensorSensitivityUnits
The units of sensitivity.
currentExcitationSource
Type: NationalInstruments.DAQmxAIExcitationSource
The source of excitation.
currentExcitationValue
Type: SystemDouble
The amount of excitation, in amperes, that the sensor requires.

Return Value

Type: AIChannel
The newly created AIChannel.

Exceptions

ExceptionCondition
DaqExceptionThe NI-DAQmx driver returned an error.

Remarks

This method creates a local virtual channel for every physical channel name you specify. If you create multiple local virtual channels with one call to this method, you can specify a comma-delimited list of names for nameToAssignChannel. If you provide fewer local virtual channel names in nameToAssignChannel than you create, NI-DAQmx automatically assigns names to the local virtual channels.

If you do not provide a value for nameToAssignChannel, NI-DAQmx uses the physicalChannelName as the local virtual channel name. If you use nameToAssignChannel to create a name for the local virtual channel, you must use this name in other properties and methods.

The NI-DAQmx driver does not determine if the requested settings are possible until the task is verified. This method does not throw an exception for parameter values that are not compatible with your hardware or other settings in your task. To determine if all of the settings for a Task are valid, you must verify the task by starting the task, either with Start or by reading from or writing to the task, or by calling Control(TaskAction) with Verify.

See Also

Log in to get a better experience