Source code for RsSmw.Implementations.Source.Bb.Wlnn.Fblock.User.Mac.Fcontrol

from .........Internal.Core import Core
from .........Internal.CommandsGroup import CommandsGroup
from .........Internal import Conversions
from .........Internal.Utilities import trim_str_response
from ......... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FcontrolCls:
	"""
	| Commands in total: 12
	| Subgroups: 11
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("fcontrol", core, parent)

	@property
	def fds(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_fds'):
			from .Fds import FdsCls
			self._fds = FdsCls(self._core, self._cmd_group)
		return self._fds

	@property
	def mdata(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_mdata'):
			from .Mdata import MdataCls
			self._mdata = MdataCls(self._core, self._cmd_group)
		return self._mdata

	@property
	def mfragments(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_mfragments'):
			from .Mfragments import MfragmentsCls
			self._mfragments = MfragmentsCls(self._core, self._cmd_group)
		return self._mfragments

	@property
	def order(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_order'):
			from .Order import OrderCls
			self._order = OrderCls(self._core, self._cmd_group)
		return self._order

	@property
	def pmanagement(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_pmanagement'):
			from .Pmanagement import PmanagementCls
			self._pmanagement = PmanagementCls(self._core, self._cmd_group)
		return self._pmanagement

	@property
	def pversion(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_pversion'):
			from .Pversion import PversionCls
			self._pversion = PversionCls(self._core, self._cmd_group)
		return self._pversion

	@property
	def retry(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_retry'):
			from .Retry import RetryCls
			self._retry = RetryCls(self._core, self._cmd_group)
		return self._retry

	@property
	def subType(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_subType'):
			from .SubType import SubTypeCls
			self._subType = SubTypeCls(self._core, self._cmd_group)
		return self._subType

	@property
	def tds(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_tds'):
			from .Tds import TdsCls
			self._tds = TdsCls(self._core, self._cmd_group)
		return self._tds

	@property
	def typePy(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_typePy'):
			from .TypePy import TypePyCls
			self._typePy = TypePyCls(self._core, self._cmd_group)
		return self._typePy

	@property
	def wep(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_wep'):
			from .Wep import WepCls
			self._wep = WepCls(self._core, self._cmd_group)
		return self._wep

[docs] def set(self, fcontrol: str, frameBlock=repcap.FrameBlock.Default, userIx=repcap.UserIx.Default) -> None: """ ``[SOURce<HW>]:BB:WLNN:FBLock<CH>:[USER<DI>]:MAC:FCONtrol`` \n Snippet: ``driver.source.bb.wlnn.fblock.user.mac.fcontrol.set(fcontrol = rawAbc, frameBlock = repcap.FrameBlock.Default, userIx = repcap.UserIx.Default)`` \n The command enters the value of the frame control field. The frame control field has a length of 2 bytes (16 bits) and is used to define the protocol version, the frame type, and its function, etc.. As an alternative, the individual bits can be set with the following commands. :param fcontrol: integer Range: #H0000,16 to #HFFFF,16 :param frameBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Fblock') :param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User') """ param = Conversions.value_to_str(fcontrol) frameBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(frameBlock, repcap.FrameBlock) userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx) self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:FBLock{frameBlock_cmd_val}:USER{userIx_cmd_val}:MAC:FCONtrol {param}')
[docs] def get(self, frameBlock=repcap.FrameBlock.Default, userIx=repcap.UserIx.Default) -> str: """ ``[SOURce<HW>]:BB:WLNN:FBLock<CH>:[USER<DI>]:MAC:FCONtrol`` \n Snippet: ``value: str = driver.source.bb.wlnn.fblock.user.mac.fcontrol.get(frameBlock = repcap.FrameBlock.Default, userIx = repcap.UserIx.Default)`` \n The command enters the value of the frame control field. The frame control field has a length of 2 bytes (16 bits) and is used to define the protocol version, the frame type, and its function, etc.. As an alternative, the individual bits can be set with the following commands. :param frameBlock: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Fblock') :param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User') :return: fcontrol: integer Range: #H0000,16 to #HFFFF,16 """ frameBlock_cmd_val = self._cmd_group.get_repcap_cmd_value(frameBlock, repcap.FrameBlock) userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx) response = self._core.io.query_str(f'SOURce<HwInstance>:BB:WLNN:FBLock{frameBlock_cmd_val}:USER{userIx_cmd_val}:MAC:FCONtrol?') return trim_str_response(response)
def clone(self) -> 'FcontrolCls': """ 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 = FcontrolCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group