"""NI-DAQmx persisted task classes."""
from nidaqmx import task, utils
__all__ = ["PersistedTask"]
[docs]
class PersistedTask:
"""Represents a saved DAQmx task.
Use the DAQmx Persisted Task properties to query information about
programmatically saved tasks.
"""
__slots__ = ["_name", "_interpreter", "__weakref__"]
[docs]
def __init__(self, name, *, grpc_options=None):
"""Initialize a new PersistedTask.
Args:
name (str): Specifies the name of the saved task.
grpc_options (Optional[:class:`~nidaqmx.GrpcSessionOptions`]): Specifies
the gRPC session options.
"""
self._name = name
self._interpreter = utils._select_interpreter(grpc_options)
[docs]
def __eq__(self, other): # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
if isinstance(other, self.__class__):
return self._name == other._name
return False
[docs]
def __hash__(self): # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
return hash(self._name)
[docs]
def __ne__(self, other): # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
return not self.__eq__(other)
[docs]
def __repr__(self): # noqa: D105 - Missing docstring in magic method (auto-generated noqa)
return f"PersistedTask(name={self._name})"
@property
def name(self):
"""str: Indicates the name of the task."""
return self._name
@property
def author(self):
"""str: Indicates the author of the task."""
val = self._interpreter.get_persisted_task_attribute_string(self._name, 0x22CC)
return val
@property
def allow_interactive_editing(self):
"""bool: Indicates whether the task can be edited in the DAQ Assistant."""
val = self._interpreter.get_persisted_task_attribute_bool(self._name, 0x22CD)
return val
@property
def allow_interactive_deletion(self):
"""bool: Indicates whether the task can be deleted through MAX."""
val = self._interpreter.get_persisted_task_attribute_bool(self._name, 0x22CE)
return val
[docs]
def delete(self):
"""Deletes this task from MAX.
This function does not clear the copy of the task stored in memory.
Use the DAQmx Clear Task function to clear that copy of the task.
"""
self._interpreter.delete_saved_task(self._name)
[docs]
def load(self):
"""Loads this saved task.
If you use this function to load a task, you must use DAQmx Clear
Task to destroy it.
Returns:
nidaqmx.task.Task: Indicates the loaded Task object.
"""
task_handle, close_on_exit = self._interpreter.load_task(self._name)
return task._TaskAlternateConstructor(task_handle, self._interpreter, close_on_exit)
class _PersistedTaskAlternateConstructor(PersistedTask):
"""Provide an alternate constructor for the PersistedTask object.
This is a private API used to instantiate a PersistedTask with an existing interpreter.
"""
# Setting __slots__ avoids TypeError: __class__ assignment: 'Base' object layout differs from 'Derived'. # noqa: W505 - doc line too long (108 > 100 characters) (auto-generated noqa)
__slots__ = ()
def __init__(self, name, interpreter):
"""Initialize a new PersistedTask with an existing interpreter.
Args:
name: Specifies the name of the PersistedTask.
interpreter: Specifies the interpreter instance.
"""
self._name = name
self._interpreter = interpreter
# Use meta-programming to change the type of this object to Scale,
# so the user isn't confused when doing introspection.
self.__class__ = PersistedTask # type: ignore[assignment]