addline (Data Acquisition Toolbox)

Add hardware lines to a digital I/O object

Syntax

lines = addline(obj,hwline,'direction')
lines = addline(obj,hwline,port,'direction')
lines = addline(obj,hwline,'direction','names')
lines = addline(obj,hwline,port,'direction','names')

Arguments

obj
A digital I/O object.

hwline
The numeric IDs of the hardware lines added to the device object. Any MATLAB vector syntax can be used.

'direction'
The line directions can be In or Out, and can be specified as a single value or a cell array of values.

port
The numeric IDs of the digital I/O port.

'names'
A descriptive line name or cell array of descriptive line names.

lines
A row vector of lines with the same length as hwline.

`obj`	A digital I/O object.
`hwline`	The numeric IDs of the hardware lines added to the device object. Any MATLAB vector syntax can be used.
'`direction`'	The line directions can be `In` or `Out`, and can be specified as a single value or a cell array of values.
`port`	The numeric IDs of the digital I/O port.
`'names'`	A descriptive line name or cell array of descriptive line names.
`lines`	A row vector of lines with the same length as `hwline`.

Description

lines = addline(obj,hwline,'direction') adds the hardware lines specified by hwline to the digital I/O object obj. direction configures the lines for either input or output. lines is a row vector of lines.

lines = addline(obj,hwline,port,'direction') adds the hardware lines specified by hwline from the port specified by port to the digital I/O object obj.

lines = addline(obj,hwline,'direction','names') adds the hardware lines specified by hwline to the digital I/O object obj. names is a descriptive line name or cell array of descriptive line names.

lines = addline(obj,hwline,port,'direction','names') adds the hardware lines specified by hwline from the port specified by port to the digital I/O object obj. direction configures the lines for either input or output. names is a descriptive line name or cell array of descriptive line names.

Remarks

Rules for Adding Lines

The numeric values you supply for hwline depend on the hardware you access. For National Instruments and Measurement Computing hardware, line IDs are "zero-based" (begin at zero).
You can add a line only once to a given digital I/O object.
Hardware line IDs are stored in the HwLine property and the associated MATLAB indices are stored in the Index property.
For a single call to addline, you can add multiple lines from one port or the same line ID from multiple ports. You cannot add multiple lines from multiple ports.
If a port ID is not explicitly referenced, lines are added first from port 0, then from port 1, and so on.
You can specify the line directions as a single value or a cell array of values. If a single direction is specified, then all added lines have that direction. If supported by the hardware, you can configure individual lines by supplying a cell array of directions.

More About MATLAB Indices

Every hardware line contained by a device object has an associated MATLAB index that is used to reference the line. Index assignments are made automatically by addline and follow these rules:

If no hardware lines are contained by the device object, then the assigned indices automatically start at one and increase monotonically. If hardware lines have already been added to the device object, then the assigned indices automatically start at the next highest index value and increase monotonically.
The resulting indices begin at one and increase monotonically up to the size of the line group.
The first indexed line represents the least significant bit (LSB) and the highest indexed line represents the most significant bit (MSB).

More About Descriptive Line Names

You can assign hardware lines descriptive names, which are stored in the LineName property. Choosing a unique descriptive name can be a useful way to identify and reference lines. For a single call to addline, you can

Specify one line name that applies to all lines that are to be added
Specify a different name for each line to be added

If the number of names specified in a single addline call is more than one but differs from the number of lines to be added, then an error is returned. If a line is to be referenced by its name, then that name must not contain symbols. If you are naming a large number of lines, then the makenames function might be useful. If a line is not assigned a descriptive name, then it must be referenced by index.

Example

Create the digital I/O object dio and add the first four hardware lines (line IDs 0-3) from port 0.

dio = digitalio('nidaq',1);
addline(dio,0:3,'in');

These lines are automatically assigned the indices 1-4. If you want to add the first four hardware lines to dio and assign descriptive names to the lines,

addline(dio,0:3,'in',{'line1','line2','line3','line4'});

Note that you can use the makenames function to create a cell array of line names. You can add the first four hardware lines (line IDs 0-3) from port 1 to the existing line group.

```
addline(dio,0:3,1,'out');
```

The new lines are automatically assigned the indices 5-8.

See Also

Functions

delete, makenames

Properties

HwLine, Index, LineName

addchannel addmuxchannel