py_canoe 3.0.3__py3-none-any.whl → 26.0.0__py3-none-any.whl

py_canoe/core/child_elements/encoding.py

@@ -0,0 +1,27 @@
+class Encoding:
+    def __init__(self, encoding):
+        self.com_object = encoding
+
+    @property
+    def factor(self) -> float:
+        return self.com_object.Factor
+
+    @property
+    def lower_bound(self) -> int:
+        return self.com_object.LowerBound
+
+    @property
+    def offset(self) -> float:
+        return self.com_object.Offset
+
+    @property
+    def text(self) -> str:
+        return self.com_object.Text
+
+    @property
+    def unit(self) -> str:
+        return self.com_object.Unit
+
+    @property
+    def upper_bound(self) -> int:
+        return self.com_object.UpperBound

py_canoe/core/child_elements/encodings.py

@@ -0,0 +1,13 @@
+from py_canoe.core.child_elements.encoding import Encoding
+
+
+class Encodings:
+    def __init__(self, encodings):
+        self.com_object = encodings
+
+    @property
+    def count(self):
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Encoding':
+        return Encoding(self.com_object.Item(index))

py_canoe/core/child_elements/environment_array.py

@@ -0,0 +1,13 @@
+from py_canoe.core.child_elements.environment_variable import EnvironmentVariable
+
+
+class EnvironmentArray:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'EnvironmentVariable':
+        return EnvironmentVariable(self.com_object.Item(index))

py_canoe/core/child_elements/environment_group.py

@@ -0,0 +1,22 @@
+from py_canoe.core.child_elements.environment_array import EnvironmentArray
+
+
+class EnvironmentGroup:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def array(self) -> 'EnvironmentArray':
+        return EnvironmentArray(self.com_object.Array)
+
+    def add(self, variable):
+        self.com_object.Add(variable)
+
+    def get_values(self):
+        return self.com_object.GetValues()
+
+    def remove(self, variable):
+        self.com_object.Remove(variable)
+
+    def set_values(self, values: list):
+        self.com_object.SetValues(values)

py_canoe/core/child_elements/environment_info.py

@@ -0,0 +1,14 @@
+class EnvironmentInfo:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def read(self) -> bool:
+        return self.com_object.Read
+
+    @property
+    def write(self) -> bool:
+        return self.com_object.Write
+
+    def get_info(self) -> list:
+        return self.com_object.GetInfo()

py_canoe/core/child_elements/environment_variable.py

@@ -0,0 +1,55 @@
+from typing import Union
+
+from py_canoe.helpers.common import DoEventsUntil
+
+ENV_VAR_CHANGE_TIMEOUT = 1
+
+
+class EnvironmentVariable:
+    def __init__(self, com_object):
+        self.com_object = com_object
+        self.VALUE_TABLE_NOTIFICATION_TYPE = {
+            0: "cValue",
+            1: "cValueAndTime",
+            2: "cValueAndTimeU"
+        }
+        self.VALUE_TABLE_TYPE = {
+            0: "INTEGER",
+            1: "FLOAT",
+            2: "STRING",
+            3: "DATA"
+        }
+
+    @property
+    def handle(self) -> int:
+        return self.com_object.Handle
+
+    @handle.setter
+    def handle(self, value: int):
+        self.com_object.Handle = value
+
+    @property
+    def notification_type(self) -> int:
+        return self.com_object.NotificationType
+
+    @notification_type.setter
+    def notification_type(self, value: int):
+        self.com_object.NotificationType = value
+
+    @property
+    def type(self) -> int:
+        return self.com_object.Type
+
+    @property
+    def value(self) -> Union[str, int, float]:
+        return self.com_object.Value
+
+    @value.setter
+    def value(self, value: Union[str, int, float]):
+        self.com_object.Value = value
+        DoEventsUntil(lambda: self._check_value_updated(value), ENV_VAR_CHANGE_TIMEOUT, "Environment Variable Change")
+
+    def _check_value_updated(self, value) -> bool:
+        set_value = value
+        get_value = self.value if self.type != 3 else tuple(self.value)
+        return get_value == set_value

py_canoe/core/child_elements/fdx_files.py

@@ -0,0 +1,50 @@
+import win32com.client
+
+
+class FDXFiles:
+    """
+    The FDXFiles object represents the collection of FDX files in a CANoe configuration.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'FDXFile':
+        return FDXFile(self.com_object.Item(index))
+
+    def add(self, file: str) -> 'FDXFile':
+        return FDXFile(self.com_object.Add(file))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class FDXFile:
+    """
+    The FDXFile object represents a single FDX file in a CANoe configuration.
+    """
+    def __init__(self, com_object):
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def enabled(self) -> bool:
+        return self.com_object.Enabled
+
+    @enabled.setter
+    def enabled(self, value: bool):
+        self.com_object.Enabled = value
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path

py_canoe/core/child_elements/file_group_data_source.py

@@ -0,0 +1,17 @@
+from py_canoe.core.child_elements.data_source_files import DataSourceFiles
+
+
+class FileGroupDataSource:
+    """
+    Represents a group data source that can import multiple files simultaneously.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def source_files(self) -> 'DataSourceFiles':
+        return DataSourceFiles(self.com_object.SourceFiles)

py_canoe/core/child_elements/general_setup.py

@@ -0,0 +1,66 @@
+import win32com.client
+
+from py_canoe.core.child_elements.ccp_setup import CCPSetup
+from py_canoe.core.child_elements.can_controller import CanController
+from py_canoe.core.child_elements.database_setup import DatabaseSetup
+from py_canoe.core.child_elements.diagnostics_setup import DiagnosticsSetup
+from py_canoe.core.child_elements.macros_setup import MacrosSetup
+from py_canoe.core.child_elements.panel_setup import PanelSetup
+from py_canoe.core.child_elements.security_setup import SecuritySetup
+from py_canoe.core.child_elements.snippet_setup import SnippetSetup
+from py_canoe.core.child_elements.visual_sequence_setup import VisualSequenceSetup
+from py_canoe.core.child_elements.xcp_setup import XCPSetup
+
+
+class GeneralSetup:
+    """
+    The MeasurementSetup object rRepresents the general settings of a CANoe configuration.
+    """
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def ccp_setup(self) -> 'CCPSetup':
+        return CCPSetup(self.com_object.CCPSetup)
+
+    def get_channels_count(self, bust_type: int) -> int:
+        return self.com_object.Channels(bust_type)
+
+    def set_channels_count(self, bust_type: int, channel: int):
+        self.com_object.SetChannels(bust_type, channel)
+
+    @property
+    def controller_setup(self, bust_type: int, channel: int) -> 'CanController':
+        return CanController(self.com_object.ControllerSetup(bust_type, channel))
+
+    @property
+    def database_setup(self) -> 'DatabaseSetup':
+        return DatabaseSetup(self.com_object.DatabaseSetup)
+
+    @property
+    def diagnostics_setup(self) -> 'DiagnosticsSetup':
+        return DiagnosticsSetup(self.com_object.DiagnosticsSetup)
+
+    @property
+    def macros_setup(self) -> 'MacrosSetup':
+        return MacrosSetup(self.com_object.MacrosSetup)
+
+    @property
+    def panel_setup(self) -> 'PanelSetup':
+        return PanelSetup(self.com_object.PanelSetup)
+
+    @property
+    def security_setup(self) -> 'SecuritySetup':
+        return SecuritySetup(self.com_object.SecuritySetup)
+
+    @property
+    def snippet_setup(self) -> 'SnippetSetup':
+        return SnippetSetup(self.com_object.SnippetSetup)
+
+    @property
+    def visual_sequence_setup(self) -> 'VisualSequenceSetup':
+        return VisualSequenceSetup(self.com_object.VisualSequenceSetup)
+
+    @property
+    def xcp_setup(self) -> 'XCPSetup':
+        return XCPSetup(self.com_object.XCPSetup)

py_canoe/core/child_elements/macros_setup.py

@@ -0,0 +1,52 @@
+import win32com.client
+
+class MacrosSetup:
+    """
+    The MacrosSetup object represents the macros settings of a CANoe configuration.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def macros(self) -> 'Macros':
+        return Macros(self.com_object.Macros)
+
+    def play(self, macro_file: str):
+        self.com_object.Play(macro_file)
+
+
+class Macros:
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Macro':
+        return Macro(self.com_object.Item(index))
+
+    def add_ex(self, file_name: str, full_name: str) -> 'Macro':
+        return Macro(self.com_object.AddEx(file_name, full_name))
+
+
+class Macro:
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    def is_running(self) -> bool:
+        return self.com_object.IsRunning()
+
+    def start(self):
+        self.com_object.Start()
+
+    def stop(self):
+        self.com_object.Stop()