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

py_canoe/core/child_elements/modules.py

@@ -0,0 +1,87 @@
+import win32com.client
+
+
+class Modules:
+    """The Modules object represents the modules of a test module in CANoe's test setup or a node in CANoe's Simulation Setup / System and Communication Setup."""
+    def __init__(self, modules_com_obj):
+        self.com_object = modules_com_obj
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Module':
+        return Module(self.com_object.Item(index))
+
+    def add(self, full_name: str) -> 'Module':
+        return Module(self.com_object.Add(full_name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class Module:
+    """The Module object represents the modules within a test module in CANoe's test setup or a »node of the Simulation Setup / System and Communication Setup of the CANoe application."""
+    def __init__(self, module_com_obj):
+        self.com_object = win32com.client.Dispatch(module_com_obj)
+
+    @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
+
+    @property
+    def references(self) -> 'References':
+        return References(self.com_object.References)
+
+
+class References:
+    """The References object represents assemblies that are used by a .NET test library."""
+    def __init__(self, references_com_obj):
+        self.com_object = references_com_obj
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Reference':
+        return Reference(self.com_object.Item(index))
+
+    def add(self, full_name: str) -> 'Reference':
+        return Reference(self.com_object.Add(full_name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class Reference:
+    """The Reference object represents a component that is used by a .NET test library module."""
+    def __init__(self, reference_com_obj):
+        self.com_object = win32com.client.Dispatch(reference_com_obj)
+
+    @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/most_disassembler.py

@@ -0,0 +1,21 @@
+class MostDisassembler:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    def symbolic_message_id_components(self, f_block_id: int, instance_id: int, function_id: int, op_type_id: int) -> int:
+        return self.com_object.SymbolicMessageIDComponents(f_block_id, instance_id, function_id, op_type_id)
+
+    def symbolic_parameter_list1(self, data_length: int, data_array: bytearray, max_params: int = 0) -> tuple:
+        return self.com_object.SymbolicParameterList1(data_length, data_array, max_params)
+
+    def symbolic_parameter_list2(self, f_block_id: int, instance_id: int, function_id: int, op_type_id: int, data_length: int, data_array: bytearray, max_params: int = 0) -> tuple:
+        return self.com_object.SymbolicParameterList2(f_block_id, instance_id, function_id, op_type_id, data_length, data_array, max_params)
+
+    def this_message_id_components(self, f_block_id: int, instance_id: int, function_id: int, op_type_id: int) -> int:
+        return self.com_object.ThisMessageIDComponents(f_block_id, instance_id, function_id, op_type_id)
+
+    def this_symbolic_message_id_components(self, f_block_name: str, function_name: str, op_type_name: str) -> int:
+        return self.com_object.ThisSymbolicMessageIDComponents(f_block_name, function_name, op_type_name)
+
+    def this_symbolic_parameter_list(self, max_params: int = 0) -> tuple:
+        return self.com_object.ThisSymbolicParameterList(max_params)

py_canoe/core/child_elements/most_network_interface.py

@@ -0,0 +1,4 @@
+class MostNetworkInterface:
+    def __init__(self, com_object):
+        # TODO: Implement the MostNetworkInterface class later if required
+        self.com_object = com_object

py_canoe/core/child_elements/namespace.py

@@ -0,0 +1,21 @@
+from py_canoe.core.child_elements.variables import Variables
+
+
+class Namespace:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def comment(self):
+        return self.com_object.Comment
+
+    @property
+    def name(self):
+        return self.com_object.Name
+
+    def variables(self) -> 'Variables':
+        return Variables(self.com_object.Variables)
+
+    def namespaces(self):
+        from py_canoe.core.child_elements.namespaces import Namespaces
+        return Namespaces(self.com_object.Namespaces)

py_canoe/core/child_elements/namespaces.py

@@ -0,0 +1,19 @@
+from py_canoe.core.child_elements.namespace import Namespace
+
+
+class Namespaces:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def count(self):
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Namespace':
+        return Namespace(self.com_object.Item(index))
+
+    def add(self, name: str):
+        return self.com_object.Add(name)
+
+    def remove(self, variable):
+        return self.com_object.Remove(variable)

py_canoe/core/child_elements/network.py

@@ -0,0 +1,18 @@
+from py_canoe.core.child_elements.devices import Devices
+
+
+class Network:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def bus_type(self) -> int:
+        return self.com_object.BusType
+
+    @property
+    def devices(self) -> Devices:
+        return Devices(self.com_object.Devices)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name

py_canoe/core/child_elements/network_adapters.py

@@ -0,0 +1,13 @@
+import win32com.client
+
+class NetworkAdapters:
+    """Represents the collection of available network adapters for VT System communication."""
+    def __init__(self, network_adapters_com_obj):
+        self.com_object = win32com.client.Dispatch(network_adapters_com_obj)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int):
+        return self.com_object.Item(index)  # Returns a NetworkAdapter object

py_canoe/core/child_elements/nodes.py

@@ -0,0 +1,119 @@
+import win32com.client
+
+from py_canoe.core.child_elements.modules import Modules
+from py_canoe.core.child_elements.signals import Signals
+
+
+class Nodes:
+    """The Nodes object represents all nodes of the Simulation Setup / System and Communication Setup of the CANoe application."""
+    def __init__(self, nodes_com_obj):
+        self.com_object = nodes_com_obj
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'Node':
+        return Node(self.com_object.Item(index))
+
+    def add(self, name: str) -> 'Node':
+        return Node(self.com_object.Add(name))
+
+    def add_test_module_ex(self, name:str, type: int) -> 'Node':
+        return Node(self.com_object.AddTestModuleEx(name, type))
+
+    def add_with_title(self, name: str) -> 'Node':
+        return Node(self.com_object.AddWithTitle(name))
+
+    def add_test_module(self, name: str) -> 'Node':
+        return Node(self.com_object.AddTestModule(name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class Node:
+    """The Node object represents a node of the Simulation Setup / System and Communication Setup of the CANoe application."""
+    def __init__(self, node_com_obj):
+        self.com_object = win32com.client.Dispatch(node_com_obj)
+
+    @property
+    def active(self) -> bool:
+        return self.com_object.Active
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def inputs(self) -> 'Signals':
+        return Signals(self.com_object.Inputs)
+
+    @property
+    def is_gateway(self) -> bool:
+        return self.com_object.IsGateway
+
+    @property
+    def modules(self) -> 'Modules':
+        return Modules(self.com_object.Modules)
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def outputs(self) -> 'Signals':
+        return Signals(self.com_object.Outputs)
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    @property
+    def port_creation(self) -> int:
+        return self.com_object.PortCreation
+
+    @port_creation.setter
+    def port_creation(self, value: int):
+        self.com_object.PortCreation = value
+
+    @property
+    def start_delay(self) -> int:
+        return self.com_object.StartDelay
+
+    @start_delay.setter
+    def start_delay(self, value: int):
+        self.com_object.StartDelay = value
+
+    @property
+    def start_delay_active(self) -> bool:
+        return self.com_object.StartDelayActive
+
+    @start_delay_active.setter
+    def start_delay_active(self, value: bool):
+        self.com_object.StartDelayActive = value
+
+    @property
+    def start_delay_from_db(self) -> bool:
+        return self.com_object.StartDelayFromDb
+
+    @start_delay_from_db.setter
+    def start_delay_from_db(self, value: bool):
+        self.com_object.StartDelayFromDb = value
+
+    @property
+    def tcp_ip_stack_setting(self):
+        return self.com_object.TcpIpStackSetting
+
+    @property
+    def test_module(self) -> bool:
+        return self.com_object.TestModule
+
+    def attach_bus(self, bus_com_obj):
+        self.com_object.AttachBus(bus_com_obj)
+
+    def detach_bus(self, bus_com_obj):
+        self.com_object.DetachBus(bus_com_obj)
+
+    def is_bus_attached(self, bus_com_obj) -> bool:
+        return self.com_object.IsBusAttached(bus_com_obj)

py_canoe/core/child_elements/panel_setup.py

@@ -0,0 +1,97 @@
+import win32com.client
+
+
+class PanelSetup:
+    """
+    The PanelSetup object represents the panel settings of a CANoe configuration.
+    """
+    def __init__(self, com_object) -> None:
+        self.com_object = com_object
+
+    def panels(self, type: int) -> 'Panels':
+        return Panels(self.com_object.Panels(type))
+
+    def save_positions(self):
+        self.com_object.SavePositions()
+
+
+class Panels:
+    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) -> 'Panel':
+        return Panel(self.com_object.Item(index))
+
+    def add(self, type: int) -> 'Panel':
+        return Panel(self.com_object.Add(type))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class Panel:
+    def __init__(self, com_object) -> None:
+        self.com_object = win32com.client.Dispatch(com_object)
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @full_name.setter
+    def full_name(self, full_name: str):
+        self.com_object.FullName = full_name
+
+    @property
+    def height(self) -> int:
+        return self.com_object.Height
+
+    @property
+    def left(self) -> int:
+        return self.com_object.Left
+
+    @left.setter
+    def left(self, value: int):
+        self.com_object.Left = value
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @property
+    def orphaned(self) -> bool:
+        return self.com_object.Orphaned
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    @property
+    def top(self) -> int:
+        return self.com_object.Top
+
+    @top.setter
+    def top(self, value: int):
+        self.com_object.Top = value
+
+    @property
+    def visible(self) -> bool:
+        return self.com_object.Visible
+
+    @visible.setter
+    def visible(self, value: bool):
+        self.com_object.Visible = value
+
+    @property
+    def width(self) -> int:
+        return self.com_object.Width
+
+    @property
+    def window_type(self) -> int:
+        return self.com_object.WindowType
+
+    @window_type.setter
+    def window_type(self, value: int):
+        self.com_object.WindowType = value

py_canoe/core/child_elements/participant.py

@@ -0,0 +1,17 @@
+import win32com.client
+
+
+class Participant:
+    """
+    Represents a single participant associated with an ApplicationModel.
+    """
+    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

py_canoe/core/child_elements/participants.py

@@ -0,0 +1,22 @@
+from py_canoe.core.child_elements.participant import Participant
+
+
+class Participants:
+    """
+    Collection of Participant objects associated with an ApplicationModel.
+    """
+    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) -> 'Participant':
+        return Participant(self.com_object.Item(index))
+
+    def add(self, participant_path: str) -> 'Participant':
+        return Participant(self.com_object.Add(participant_path))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)

py_canoe/core/child_elements/ports.py

@@ -0,0 +1,81 @@
+import win32com.client
+
+
+class Ports:
+    """The Ports object represents all ports of a specific Ethernet bus in Network-based Access mode as a collection."""
+    def __init__(self, ports_com_obj):
+        self.com_object = win32com.client.Dispatch(ports_com_obj)
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    @property
+    def is_port_based_config(self) -> bool:
+        return self.com_object.IsPortBasedConfig
+
+    @property
+    def is_switched_network(self) -> bool:
+        return self.com_object.IsSwitchedNetwork
+
+    def item(self, index: int) -> 'Port':
+        return Port(self.com_object.Item(index))
+
+    @property
+    def network_name(self) -> str:
+        return self.com_object.NetworkName
+
+    @property
+    def ports_are_simulated(self) -> bool:
+        return self.com_object.PortsAreSimulated
+
+    @ports_are_simulated.getter
+    def ports_are_simulated(self, value: bool):
+        self.com_object.PortsAreSimulated = value
+
+    def add(self, port_name: str, segment_name: str) -> 'Port':
+        return Port(self.com_object.Add(port_name, segment_name))
+
+    def add_mp(self, port_name: str) -> 'Port':
+        return Port(self.com_object.AddMP(port_name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class Port:
+    """The Port object represents a specific port of a CANoe configuration."""
+    def __init__(self, port_com_obj):
+        self.com_object = win32com.client.Dispatch(port_com_obj)
+
+    @property
+    def is_active(self) -> bool:
+        return self.com_object.IsActive
+
+    @is_active.setter
+    def is_active(self, value: bool):
+        self.com_object.IsActive = value
+
+    @property
+    def is_simulated(self) -> bool:
+        return self.com_object.IsSimulated
+
+    @is_simulated.setter
+    def is_simulated(self, value: bool):
+        self.com_object.IsSimulated = value
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @name.setter
+    def name(self, value: str):
+        self.com_object.Name = value
+
+    @property
+    def segment_name(self) -> str:
+        return self.com_object.SegmentName
+
+    @segment_name.setter
+    def segment_name(self, value: str):
+        self.com_object.SegmentName = value

py_canoe/core/child_elements/replay_collection.py

@@ -0,0 +1,56 @@
+import win32com.client
+
+
+class ReplayCollection:
+    """The ReplayCollection object represents the Replay Blocks of the CANoe application."""
+    def __init__(self, replay_collection_com_obj):
+        self.com_object = replay_collection_com_obj
+
+    @property
+    def count(self) -> int:
+        return self.com_object.Count
+
+    def item(self, index: int) -> 'ReplayBlock':
+        return ReplayBlock(self.com_object.Item(index))
+
+    def add(self, name: str) -> 'ReplayBlock':
+        return ReplayBlock(self.com_object.Add(name))
+
+    def remove(self, index: int):
+        self.com_object.Remove(index)
+
+
+class ReplayBlock:
+    """The ReplayBlock object represents a Replay Block of the CANoe application."""
+    def __init__(self, replay_block_com_obj):
+        self.com_object = win32com.client.Dispatch(replay_block_com_obj)
+
+    @property
+    def enabled(self) -> bool:
+        return self.com_object.Enabled
+
+    @enabled.setter
+    def enabled(self, value: bool):
+        self.com_object.Enabled = value
+
+    @property
+    def name(self) -> str:
+        return self.com_object.Name
+
+    @name.setter
+    def name(self, value: str):
+        self.com_object.Name = value
+
+    @property
+    def path(self) -> str:
+        return self.com_object.Path
+
+    @path.setter
+    def path(self, value: str):
+        self.com_object.Path = value
+
+    def start(self):
+        self.com_object.Start()
+
+    def stop(self):
+        self.com_object.Stop()

py_canoe/core/child_elements/security_configuration.py

@@ -0,0 +1,20 @@
+class SecurityConfiguration:
+    """The SecurityConfiguration object represents a security profile assignment to a network, TCP stack or observer."""
+    def __init__(self, security_configuration_com_obj):
+        self.com_object = security_configuration_com_obj
+
+    @property
+    def security_active(self) -> bool:
+        return self.com_object.SecurityActive
+
+    @security_active.setter
+    def security_active(self, value: bool):
+        self.com_object.SecurityActive = value
+
+    @property
+    def security_profile(self) -> int:
+        return self.com_object.SecurityProfile
+
+    @security_profile.setter
+    def security_profile(self, value: int):
+        self.com_object.SecurityProfile = value

py_canoe/core/child_elements/security_setup.py

@@ -0,0 +1,31 @@
+import win32com.client
+
+
+class SecuritySetup:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def tls_observer_security_configuration(self) -> 'SecurityConfiguration':
+        return SecurityConfiguration(self.com_object.TLSObserverSecurityConfiguration)
+
+
+class SecurityConfiguration:
+    def __init__(self, com_object):
+        self.com_object = com_object
+
+    @property
+    def security_active(self) -> bool:
+        return self.com_object.SecurityActive
+
+    @security_active.setter
+    def security_active(self, value: bool):
+        self.com_object.SecurityActive = value
+
+    @property
+    def security_profile(self) -> str:
+        return self.com_object.SecurityProfile
+
+    @security_profile.setter
+    def security_profile(self, value: str):
+        self.com_object.SecurityProfile = value

py_canoe/core/child_elements/signals.py

@@ -0,0 +1,39 @@
+from typing import Union
+
+
+class Signals:
+    def __init__(self, signals_com_object):
+        self.com_object = signals_com_object
+
+
+class Signal:
+    def __init__(self, signal_com_object):
+        self.com_object = signal_com_object
+
+    @property
+    def full_name(self) -> str:
+        return self.com_object.FullName
+
+    @property
+    def is_online(self) -> bool:
+        return self.com_object.IsOnline
+
+    @property
+    def raw_value(self) -> int:
+        return self.com_object.RawValue
+
+    @raw_value.setter
+    def raw_value(self, value: int):
+        self.com_object.RawValue = value
+
+    @property
+    def state(self) -> int:
+        return self.com_object.State
+
+    @property
+    def value(self) -> Union[int, float]:
+        return self.com_object.Value
+
+    @value.setter
+    def value(self, value: Union[int, float]):
+        self.com_object.Value = value