from collections.abc import Sequence
from nidaqmx.errors import DaqError
from nidaqmx.error_codes import DAQmxErrors
from nidaqmx.system.physical_channel import PhysicalChannel, _PhysicalChannelAlternateConstructor
from nidaqmx.utils import unflatten_channel_string, flatten_channel_string
[docs]class PhysicalChannelCollection(Sequence):
"""
Contains the collection of physical channels for a DAQmx device.
This class defines methods that implements a container object.
"""
def __init__(self, device_name, interpreter):
"""
Do not construct this object directly; instead, construct a nidaqmx.system.Device and use the appropriate property, such as device.ai_physical_channels.
"""
self._name = device_name
self._interpreter = interpreter
def __contains__(self, item):
channel_names = self.channel_names
if isinstance(item, str):
items = unflatten_channel_string(item)
return all([i in channel_names for i in items])
elif isinstance(item, PhysicalChannel):
return item._name in channel_names
return False
def __eq__(self, other):
if isinstance(other, self.__class__):
return self._name == other._name
return False
def __getitem__(self, index):
"""
Indexes a subset of physical channels on this physical channel
collection.
Args:
index: The value of the index. The following index types
are supported:
- str: Name of the physical channel, without the
device name prefix, e.g. 'ai0'. You also can
specify a string that contains a list or range of
names to this input. If you have a list of names,
use the DAQmx Flatten Channel String function to
convert the list to a string.
- int: Index/position of the physical channel in the
collection.
- slice: Range of the indexes/positions of physical
channels in the collection.
Returns:
nidaqmx.system.physical_channel.PhysicalChannel:
Indicates the subset of physical channels indexed.
"""
if isinstance(index, int):
return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
elif isinstance(index, slice):
return _PhysicalChannelAlternateConstructor(self.channel_names[index], self._interpreter)
elif isinstance(index, str):
return _PhysicalChannelAlternateConstructor(f'{self._name}/{index}', self._interpreter)
else:
raise DaqError(
'Invalid index type "{}" used to access collection.'
.format(type(index)), DAQmxErrors.UNKNOWN)
def __iter__(self):
for channel_name in self.channel_names:
yield _PhysicalChannelAlternateConstructor(channel_name, self._interpreter)
def __len__(self):
return len(self.channel_names)
def __ne__(self, other):
return not self.__eq__(other)
def __reversed__(self):
channel_names = self.channel_names
channel_names.reverse()
for channel_name in channel_names:
yield _PhysicalChannelAlternateConstructor(channel_name, self._interpreter)
@property
def all(self):
"""
nidaqmx.system.physical_channel.PhysicalChannel: Specifies a
physical channel object that represents the entire list of
physical channels on this channel collection.
"""
return _PhysicalChannelAlternateConstructor(flatten_channel_string(self.channel_names), self._interpreter)
@property
def channel_names(self):
"""
List[str]: Specifies the entire list of physical channels on this
collection.
"""
raise NotImplementedError()
[docs]class AIPhysicalChannelCollection(PhysicalChannelCollection):
"""
Contains the collection of analog input physical channels for a
DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x231e)
return unflatten_channel_string(val)
[docs]class AOPhysicalChannelCollection(PhysicalChannelCollection):
"""
Contains the collection of analog output physical channels for a
DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x231f)
return unflatten_channel_string(val)
[docs]class CIPhysicalChannelCollection(PhysicalChannelCollection):
"""
Contains the collection of counter input physical channels for a
DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2324)
return unflatten_channel_string(val)
[docs]class COPhysicalChannelCollection(PhysicalChannelCollection):
"""
Contains the collection of counter output physical channels for a
DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2325)
return unflatten_channel_string(val)
[docs]class DILinesCollection(PhysicalChannelCollection):
"""
Contains the collection of digital input lines for a DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2320)
return unflatten_channel_string(val)
[docs]class DOLinesCollection(PhysicalChannelCollection):
"""
Contains the collection of digital output lines for a DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2322)
return unflatten_channel_string(val)
[docs]class DIPortsCollection(PhysicalChannelCollection):
"""
Contains the collection of digital input ports for a DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2321)
return unflatten_channel_string(val)
[docs]class DOPortsCollection(PhysicalChannelCollection):
"""
Contains the collection of digital output ports for a DAQmx device.
This class defines methods that implements a container object.
"""
@property
def channel_names(self):
val = self._interpreter.get_device_attribute_string(self._name, 0x2323)
return unflatten_channel_string(val)