from typing import List
from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Utilities import trim_str_response
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class NetCls:
"""Net commands group definition. 7 total commands, 2 Subgroups, 5 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("net", core, parent)
@property
def dns(self):
"""dns commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_dns'):
from .Dns import DnsCls
self._dns = DnsCls(self._core, self._cmd_group)
return self._dns
@property
def subnet(self):
"""subnet commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_subnet'):
from .Subnet import SubnetCls
self._subnet = SubnetCls(self._core, self._cmd_group)
return self._subnet
[docs] def get_adapter(self) -> str:
"""SCPI: SYSTem:COMMunicate:NET:ADAPter \n
Snippet: value: str = driver.system.communicate.net.get_adapter() \n
Selects the network adapter and thus the connection type to be modified. All SYSTem:COMMunicate:NET... commands affect
the selected network adapter. This command does not activate or deactivate a network adapter. \n
:return: network_adapter: No help available
"""
response = self._core.io.query_str('SYSTem:COMMunicate:NET:ADAPter?')
return trim_str_response(response)
[docs] def set_adapter(self, network_adapter: str) -> None:
"""SCPI: SYSTem:COMMunicate:NET:ADAPter \n
Snippet: driver.system.communicate.net.set_adapter(network_adapter = '1') \n
Selects the network adapter and thus the connection type to be modified. All SYSTem:COMMunicate:NET... commands affect
the selected network adapter. This command does not activate or deactivate a network adapter. \n
:param network_adapter: String parameter
"""
param = Conversions.value_to_quoted_str(network_adapter)
self._core.io.write(f'SYSTem:COMMunicate:NET:ADAPter {param}')
[docs] def get_gateway(self) -> str:
"""SCPI: SYSTem:COMMunicate:NET:GATeway \n
Snippet: value: str = driver.system.communicate.net.get_gateway() \n
Defines IPv4 addresses of default gateways. The configuration is only possible if DHCP is disabled. A query returns the
currently defined addresses, irrespective of whether they have been specified manually or via DHCP. \n
:return: gateway: No help available
"""
response = self._core.io.query_str('SYSTem:COMMunicate:NET:GATeway?')
return trim_str_response(response)
[docs] def set_gateway(self, gateway: str) -> None:
"""SCPI: SYSTem:COMMunicate:NET:GATeway \n
Snippet: driver.system.communicate.net.set_gateway(gateway = '1') \n
Defines IPv4 addresses of default gateways. The configuration is only possible if DHCP is disabled. A query returns the
currently defined addresses, irrespective of whether they have been specified manually or via DHCP. \n
:param gateway: String parameter, gateway IP address consisting of four blocks separated by dots Several strings separated by commas can be entered, or several addresses separated by commas can be included in one string.
"""
param = Conversions.value_to_quoted_str(gateway)
self._core.io.write(f'SYSTem:COMMunicate:NET:GATeway {param}')
[docs] def get_ip_address(self) -> List[str]:
"""SCPI: SYSTem:COMMunicate:NET:IPADdress \n
Snippet: value: List[str] = driver.system.communicate.net.get_ip_address() \n
Assigns one or more IPv4 addresses to the network adapter. The configuration is only possible if DHCP is disabled.
A query returns the currently assigned addresses, irrespective of whether they have been assigned manually or via DHCP. \n
:return: ip_address: No help available
"""
response = self._core.io.query_str('SYSTem:COMMunicate:NET:IPADdress?')
return Conversions.str_to_str_list(response)
[docs] def set_ip_address(self, ip_address: List[str]) -> None:
"""SCPI: SYSTem:COMMunicate:NET:IPADdress \n
Snippet: driver.system.communicate.net.set_ip_address(ip_address = ['1', '2', '3']) \n
Assigns one or more IPv4 addresses to the network adapter. The configuration is only possible if DHCP is disabled.
A query returns the currently assigned addresses, irrespective of whether they have been assigned manually or via DHCP. \n
:param ip_address: String parameter, IP address consisting of four blocks (octets) separated by dots Several strings separated by commas can be entered, or several addresses separated by commas can be included in one string.
"""
param = Conversions.list_to_csv_quoted_str(ip_address)
self._core.io.write(f'SYSTem:COMMunicate:NET:IPADdress {param}')
[docs] def get_hostname(self) -> str:
"""SCPI: SYSTem:COMMunicate:NET:HOSTname \n
Snippet: value: str = driver.system.communicate.net.get_hostname() \n
Sets the host name of the CMA. \n
:return: hostname: No help available
"""
response = self._core.io.query_str('SYSTem:COMMunicate:NET:HOSTname?')
return trim_str_response(response)
[docs] def set_hostname(self, hostname: str) -> None:
"""SCPI: SYSTem:COMMunicate:NET:HOSTname \n
Snippet: driver.system.communicate.net.set_hostname(hostname = '1') \n
Sets the host name of the CMA. \n
:param hostname: Host name as string
"""
param = Conversions.value_to_quoted_str(hostname)
self._core.io.write(f'SYSTem:COMMunicate:NET:HOSTname {param}')
[docs] def get_dhcp(self) -> bool:
"""SCPI: SYSTem:COMMunicate:NET:DHCP \n
Snippet: value: bool = driver.system.communicate.net.get_dhcp() \n
Enables or disables DHCP. \n
:return: dhcp_enable: No help available
"""
response = self._core.io.query_str('SYSTem:COMMunicate:NET:DHCP?')
return Conversions.str_to_bool(response)
[docs] def set_dhcp(self, dhcp_enable: bool) -> None:
"""SCPI: SYSTem:COMMunicate:NET:DHCP \n
Snippet: driver.system.communicate.net.set_dhcp(dhcp_enable = False) \n
Enables or disables DHCP. \n
:param dhcp_enable: 1 | 0 1: DHCP enabled and automatic TCP/IP address configuration 0: DHCP disabled and manual address configuration
"""
param = Conversions.bool_to_str(dhcp_enable)
self._core.io.write(f'SYSTem:COMMunicate:NET:DHCP {param}')
def clone(self) -> 'NetCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = NetCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group