ska-tmc-common
1.13.0
Table of Contents
Introduction
Developer Guide
TMC Common AdapterFactory
TMC CommandDispatcher
TMC Common TMCBaseDevice
TMC Base Command Class
TMC Common TMC Component Manager
v4: Config-driven Component Managers
Config Data Classes
TMC Common EventReceiver
TMC Common EventManager
Dish Utils
Base TMC Command Design
Thread Manager
Knowledge Base
Releases
Change Log
ska-tmc-common
Developer Guide
View page source
Developer Guide
TMC Common AdapterFactory
1. AdapterFactory
2. AdapterType
3. BaseAdapter
4. CspMasterAdapter
5. SubarrayAdapter
6. SdpSubArrayAdapter
7. MCCSMasterLeafNodeAdapter
8. DishAdapter
9. CspSubarrayAdapter
10. MCCSControllerAdapter
11. DishLeafAdapter
12. DishlnPointingDeviceAdapter
TMC CommandDispatcher
Overview
Integration in Downstream Repositories
Best Practices
TMC Common TMCBaseDevice
1. TMCBaseDevice
TMC Base Command Class
1. BaseTMCCommand
2. TMCCommand
3. TmcLeafNodeCommand
4. BaseTMCCommand
TMC Common TMC Component Manager
1. TmcComponent
2. BaseTmcComponentManager
3. TmcComponentManager
4. TmcLeafNodeComponentManager
v4: Config-driven Component Managers
5. TmcComponent (v4)
6. BaseTmcComponentManager (v4)
7. TmcComponentManager (v4)
8. TmcLeafNodeComponentManager (v4)
Config Data Classes
Overview
1. TimeoutConfig
2. TelmodelConfig
3. BaseTmcComponentManagerConfig
4. TmcComponentManagerConfig
5. TmcLeafNodeConfig
Guidelines: Adding or Changing Fields
TMC Common EventReceiver
1. EventReceiver
TMC Common EventManager
1. EventManager
Dish Utils
1. AntennaLocation
2. AntennaParams
3. DishHelper
Base TMC Command Design
Overview
Design
Command Workflow
Responsibilities
Required Methods
Optional Hooks
Completion Tracking
Command Invocation Callback
Result Evaluation
Command Execution Responsibilities
Best Practices
Thread Manager
Overview
Design
Thread Lifecycle
Responsibilities
Thread Factory
Public API
Convenience API
Choosing Between register() and start_worker()
Graceful Shutdown
Best Practices