Source code for RsSmw.Implementations.Source.Bb.Gnss.AdGeneration.Galileo.ToaData

from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.StructBase import StructBase
from .......Internal.ArgStruct import ArgStruct
from ....... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ToaDataCls:
	"""
	| Commands in total: 7
	| Subgroups: 0
	| Direct child commands: 7
	"""

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

	# noinspection PyTypeChecker
[docs] class DateStruct(StructBase): """ Structure for reading output parameters. Fields: \n - Year: int: integer Range: 1980 to 9999 - Month: int: integer Range: 1 to 12 - Day: int: integer Range: 1 to 31 """ __meta_args_list = [ ArgStruct.scalar_int('Year'), ArgStruct.scalar_int('Month'), ArgStruct.scalar_int('Day')] def __init__(self): StructBase.__init__(self, self) self.Year: int=None self.Month: int=None self.Day: int=None
[docs] def get_date(self) -> DateStruct: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:DATE`` \n Snippet: ``value: DateStruct = driver.source.bb.gnss.adGeneration.galileo.toaData.get_date()`` \n Enabled for UTC or GLONASS timebase (method ``RsSmw.source.bb.gnss.adGeneration.gps.toaData.tbasis()`` ) . Queries the date for the assistance data in DMS format of the Gregorian calendar. :return: structure: for return value, see the help for DateStruct structure arguments. """ return self._core.io.query_struct('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:DATE?', self.__class__.DateStruct())
[docs] def get_duration(self) -> float: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:DURation`` \n Snippet: ``value: float = driver.source.bb.gnss.adGeneration.galileo.toaData.get_duration()`` \n Sets the duration of the assistance data. :return: duration: float Range: 1E-3 to 5E3 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:DURation?') return Conversions.str_to_float(response)
[docs] def set_duration(self, duration: float) -> None: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:DURation`` \n Snippet: ``driver.source.bb.gnss.adGeneration.galileo.toaData.set_duration(duration = 1.0)`` \n Sets the duration of the assistance data. :param duration: float Range: 1E-3 to 5E3 """ param = Conversions.decimal_value_to_str(duration) self._core.io.write(f'SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:DURation {param}')
[docs] def get_resolution(self) -> float: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:RESolution`` \n Snippet: ``value: float = driver.source.bb.gnss.adGeneration.galileo.toaData.get_resolution()`` \n Sets the resolution of the assistance data. :return: resolution: float Range: 1E-3 to 5 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:RESolution?') return Conversions.str_to_float(response)
[docs] def set_resolution(self, resolution: float) -> None: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:RESolution`` \n Snippet: ``driver.source.bb.gnss.adGeneration.galileo.toaData.set_resolution(resolution = 1.0)`` \n Sets the resolution of the assistance data. :param resolution: float Range: 1E-3 to 5 """ param = Conversions.decimal_value_to_str(resolution) self._core.io.write(f'SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:RESolution {param}')
# noinspection PyTypeChecker
[docs] def get_tbasis(self) -> enums.TimeBasis: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:TBASis`` \n Snippet: ``value: enums.TimeBasis = driver.source.bb.gnss.adGeneration.galileo.toaData.get_tbasis()`` \n Queries the timebase for the time of assistance data parameters. Set the timebase via the following command: SOURce1:BB:GNSS:TIME:STARt:TBASis :return: time_basis: UTC | GPS | GST | GLO | BDT | NAV """ response = self._core.io.query_str('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:TBASis?') return Conversions.str_to_scalar_enum(response, enums.TimeBasis)
# noinspection PyTypeChecker
[docs] class TimeStruct(StructBase): """ Structure for reading output parameters. Fields: \n - Hour: int: integer Range: 0 to 23 - Minute: int: integer Range: 0 to 59 - Second: float: float Range: 0 to 59.999 """ __meta_args_list = [ ArgStruct.scalar_int('Hour'), ArgStruct.scalar_int('Minute'), ArgStruct.scalar_float('Second')] def __init__(self): StructBase.__init__(self, self) self.Hour: int=None self.Minute: int=None self.Second: float=None
[docs] def get_time(self) -> TimeStruct: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:TIME`` \n Snippet: ``value: TimeStruct = driver.source.bb.gnss.adGeneration.galileo.toaData.get_time()`` \n Queries the exact start time of the assistance data in UTC time format. Querying requires the UTC timebase or GLONASS timebase: SOURce1:BB:GNSS:ADGeneration:GPS:TOAData:TBASis UTC SOURce1:BB:GNSS:ADGeneration:GPS:TOAData:TBASis GLONASS See also method ``RsSmw.source.bb.gnss.adGeneration.qzss.toaData.tbasis()`` . :return: structure: for return value, see the help for TimeStruct structure arguments. """ return self._core.io.query_struct('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:TIME?', self.__class__.TimeStruct())
[docs] def get_to_week(self) -> int: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:TOWeek`` \n Snippet: ``value: int = driver.source.bb.gnss.adGeneration.galileo.toaData.get_to_week()`` \n Queries the Time of Week (TOW) of the assistance data for the related GNSS timebase. See also method ``RsSmw.source.bb.gnss.adGeneration.qzss.toaData.tbasis()`` . :return: tow: integer Range: -604800 to 604800 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:TOWeek?') return Conversions.str_to_int(response)
[docs] def get_wnumber(self) -> int: """ ``[SOURce<HW>]:BB:GNSS:ADGeneration:GALileo:TOAData:WNUMber`` \n Snippet: ``value: int = driver.source.bb.gnss.adGeneration.galileo.toaData.get_wnumber()`` \n Queries the week number (WN) of the assistance data for the related GNSS timebase. See also method ``RsSmw.source.bb.gnss.adGeneration.qzss.toaData.tbasis()`` . :return: week_number: integer Range: 0 to 9999.0``*53`` """ response = self._core.io.query_str('SOURce<HwInstance>:BB:GNSS:ADGeneration:GALileo:TOAData:WNUMber?') return Conversions.str_to_int(response)