Source code for py_dss_interface.models.Monitors.MonitorsS

# -*- encoding: utf-8 -*-
"""
 Created by eniocc at 11/10/2020
"""
import ctypes

from py_dss_interface.models.Base import Base


[docs]class MonitorsS(Base): """ This interface can be used to read/write certain properties of the active DSS object. The structure of the interface is as follows: CStr MonitorsS(int32_t Parameter, CStr Argument); This interface returns a string according to the number sent in the variable “parameter”. The parameter can be one of the following. """
[docs] def monitors_file_name(self) -> str: """Returns the name of the CSV file associated with active monitor.""" result = ctypes.c_char_p(self.dss_obj.MonitorsS(ctypes.c_int32(0), ctypes.c_int32(0))) return result.value.decode('ascii')
[docs] def monitors_read_name(self) -> str: """Returns the active Monitor object by name.""" result = ctypes.c_char_p(self.dss_obj.MonitorsS(ctypes.c_int32(1), ctypes.c_int32(0))) return result.value.decode('ascii')
[docs] def monitors_write_name(self, argument) -> str: """Sets the active Monitor object by name.""" result = ctypes.c_char_p(self.dss_obj.MonitorsS(ctypes.c_int32(2), argument.encode('ascii'))) return result.value.decode('ascii')
[docs] def monitors_read_element(self) -> str: """Returns the full name of element being monitored by the active Monitor.""" result = ctypes.c_char_p(self.dss_obj.MonitorsS(ctypes.c_int32(3), ctypes.c_int32(0))) return result.value.decode('ascii')
[docs] def monitors_write_element(self, argument) -> str: """Sets the full name of element being monitored by the active Monitor.""" result = ctypes.c_char_p(self.dss_obj.MonitorsS(ctypes.c_int32(4), argument.encode('ascii'))) return result.value.decode('ascii')