nidaqmx.task.channel

class nidaqmx._task_modules.channels.channel.Channel(task_handle, virtual_or_physical_name)[source]

Bases: object

Represents virtual channel or a list of virtual channels.

property chan_type

Indicates the type of the virtual channel.

Type

nidaqmx.constants.ChannelType

property channel_names

Specifies the unflattened list of the virtual channels.

Type

List[str]

property description

Specifies a user-defined description for the channel.

Type

str

property is_global

Indicates whether the channel is a global channel.

Type

bool

property name

Specifies the name of the virtual channel this object represents.

Type

str

property physical_channel

nidaqmx.system.physical_channel.PhysicalChannel: Specifies the name of the physical channel upon which this virtual channel is based.

save(save_as='', author='', overwrite_existing_channel=False, allow_interactive_editing=True, allow_interactive_deletion=True)[source]

Saves this local or global channel to MAX as a global channel.

Parameters

  • save_as (Optional[str]) – Is the name to save the task, global channel, or custom scale as. If you do not specify a value for this input, NI-DAQmx uses the name currently assigned to the task, global channel, or custom scale.

  • author (Optional[str]) – Is a name to store with the task, global channel, or custom scale.

  • overwrite_existing_channel (Optional[bool]) – Specifies whether to overwrite a global channel of the same name if one is already saved in MAX. If this input is False and a global channel of the same name is already saved in MAX, this function returns an error.

  • allow_interactive_editing (Optional[bool]) – Specifies whether to allow the task, global channel, or custom scale to be edited in the DAQ Assistant. If allow_interactive_editing is True, the DAQ Assistant must support all task or global channel settings.

  • allow_interactive_deletion (Optional[bool]) – Specifies whether to allow the task, global channel, or custom scale to be deleted through MAX.

property sync_unlock_behavior

Specifies the action to take if the target loses its synchronization to the grand master.

Type

nidaqmx.constants.SyncUnlockBehavior