Skip to content
Snippets Groups Projects
Commit 1fec15ba authored by toor's avatar toor
Browse files

CT-126: Added documentation.

parent 5e38165b
No related branches found
No related tags found
No related merge requests found
.. LMC Base Classes documentation master file, created by
sphinx-quickstart on Fri Jan 11 10:03:42 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
SKA CSP Sub-element Subarray
============================================
This module implements a generic Subarray device for a CSP Sub-element.
The scope of this module is to provide a uniform access to a CSP Sub-element
subarray from the CSP.LMC side.
.. toctree::
:maxdepth: 2
.. automodule:: ska.base.csp_subelement_subarray
.. autoclass:: ska.base.CspSubElementSubarray
:members:
:undoc-members:
...@@ -21,6 +21,7 @@ Welcome to LMC Base Classes documentation! ...@@ -21,6 +21,7 @@ Welcome to LMC Base Classes documentation!
Device: SKA Subarray<SKASubarray> Device: SKA Subarray<SKASubarray>
Device: SKA CSP Sub-element Master<CspSubElementMaster> Device: SKA CSP Sub-element Master<CspSubElementMaster>
Device: SKA CSP Sub-element Subarray<CspSubElementSubarray>
SKA Control Model<Control_Model> SKA Control Model<Control_Model>
SKA Commands<Commands> SKA Commands<Commands>
......
...@@ -49,6 +49,7 @@ setuptools.setup( ...@@ -49,6 +49,7 @@ setuptools.setup(
"SKASubarray=ska.base.subarray_device:main", "SKASubarray=ska.base.subarray_device:main",
"SKATelState=ska.base.tel_state_device:main", "SKATelState=ska.base.tel_state_device:main",
"CspSubelementMaster=ska.base.csp_subelement_master:main", "CspSubelementMaster=ska.base.csp_subelement_master:main",
"CspSubelementSubarray=ska.base.csp_subelement_subarray:main",
] ]
}, },
keywords="lmc base classes ska", keywords="lmc base classes ska",
......
...@@ -38,10 +38,6 @@ __all__ = ["CspSubElementSubarray", "main"] ...@@ -38,10 +38,6 @@ __all__ = ["CspSubElementSubarray", "main"]
class CspSubElementSubarray(SKASubarray): class CspSubElementSubarray(SKASubarray):
""" """
Subarray device for SKA CSP SubElement Subarray device for SKA CSP SubElement
**Properties:**
- Device Property
""" """
# PROTECTED REGION ID(CspSubElementSubarray.class_variable) ENABLED START # # PROTECTED REGION ID(CspSubElementSubarray.class_variable) ENABLED START #
# PROTECTED REGION END # // CspSubElementSubarray.class_variable # PROTECTED REGION END # // CspSubElementSubarray.class_variable
...@@ -232,7 +228,7 @@ class CspSubElementSubarray(SKASubarray): ...@@ -232,7 +228,7 @@ class CspSubElementSubarray(SKASubarray):
# configure the flag to push event from the device server # configure the flag to push event from the device server
device.set_change_event('timeoutExpiredFlag', True, True) device.set_change_event('timeoutExpiredFlag', True, True)
message = "CspSubElementSubarray Init comma,nd completed OK" message = "CspSubElementSubarray Init command completed OK"
device.logger.info(message) device.logger.info(message)
return (ResultCode.OK, message) return (ResultCode.OK, message)
...@@ -305,7 +301,7 @@ class CspSubElementSubarray(SKASubarray): ...@@ -305,7 +301,7 @@ class CspSubElementSubarray(SKASubarray):
def read_configureScanMeasuredDuration(self): def read_configureScanMeasuredDuration(self):
# PROTECTED REGION ID(CspSubElementSubarray.configureScanMeasuredDuration_read) ENABLED START # # PROTECTED REGION ID(CspSubElementSubarray.configureScanMeasuredDuration_read) ENABLED START #
"""Return the configureScanMeasuredDuration attribute.""" """Return the configureScanMeasuredDuration attribute."""
return 0.0 return self._cmd_measured_duration['configurescan']
# PROTECTED REGION END # // CspSubElementSubarray.configureScanMeasuredDuration_read # PROTECTED REGION END # // CspSubElementSubarray.configureScanMeasuredDuration_read
def read_listOfDevicesCompletedTasks(self): def read_listOfDevicesCompletedTasks(self):
...@@ -427,8 +423,7 @@ class CspSubElementSubarray(SKASubarray): ...@@ -427,8 +423,7 @@ class CspSubElementSubarray(SKASubarray):
def validate_configuration_data(self, argin): def validate_configuration_data(self, argin):
""" """
Validate the configuration parameters against allowed values, as needed. Validate the configuration parameters against allowed values, as needed.
:param argin: :param argin: The JSON formatted string with configuration for the device.
The JSON formatted string with configuration for the device.
:type argin: 'DevString' :type argin: 'DevString'
:return: A tuple containing a return code and a string message. :return: A tuple containing a return code and a string message.
:rtype: (ResultCode, str) :rtype: (ResultCode, str)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment