A Python base class for a BASDA worker (executing a command). More...
Inheritance diagram for BasdaService.WorkerSkeleton:
Collaboration diagram for BasdaService.WorkerSkeleton:
Public Member Functions | |
| def | __init__ (self, _svcName) |
| def | cmdStart (self, _str) |
| initiate a command. More... | |
| def | cmdDone (self) |
| actions after terminating the command. More... | |
| def | cmdPercent (self, _i) |
| declare the command be partially completed. More... | |
| def | cmdAction (self, _i, _str) |
| declare the command be partially completed. More... | |
| def | __init__ (self, _svcName) |
| def | cmdStart (self, _str) |
| initiate a command. More... | |
| def | cmdDone (self) |
| actions after terminating the command. More... | |
| def | cmdPercent (self, _i) |
| declare the command be partially completed. More... | |
| def | cmdAction (self, _i, _str) |
| declare the command be partially completed. More... | |
 Public Member Functions inherited from BasdaService.Worker | |
| def | __init__ (self, _svcName) |
| def | name (self) |
| def | config (self, _node) |
| def | cfg (self, _node) |
| def | var (self, _node) |
| def | abort (self) |
| dummy (does nothing) More... | |
| def | stop (self) |
| dummy (does nothing) More... | |
| def | init (self) |
| dummy (does nothing) More... | |
| def | deinit (self) |
| dummy (does nothing) More... | |
| def | activate (self) |
| dummy (does nothing) More... | |
| def | deactivate (self) |
| dummy (does nothing) More... | |
| def | idleOffline (self) |
| dummy (waits for state change) More... | |
| def | idleStandby (self) |
| dummy (waits for state change) More... | |
| def | idleOnline (self) |
| dummy (waits for state change) More... | |
| def | errorOffline (self) |
| action in response to an error while offline Sets the state to OFFLINE More... | |
| def | errorStandby (self) |
| action in response to an error while in standby Sets the state to OFFLINE More... | |
| def | errorOnline (self) |
| action in response to an error while online Sets the state to OFFLINE More... | |
| def | errorWorking (self) |
| action in response to an error while executing a command Sets the state to OFFLINE More... | |
| def | __init__ (self, _svcName) |
| def | name (self) |
| def | config (self, _node) |
| def | cfg (self, _node) |
| def | var (self, _node) |
| def | abort (self) |
| dummy (does nothing) More... | |
| def | stop (self) |
| dummy (does nothing) More... | |
| def | init (self) |
| dummy (does nothing) More... | |
| def | deinit (self) |
| dummy (does nothing) More... | |
| def | activate (self) |
| dummy (does nothing) More... | |
| def | deactivate (self) |
| dummy (does nothing) More... | |
| def | idleOffline (self) |
| dummy (waits for state change) More... | |
| def | idleStandby (self) |
| dummy (waits for state change) More... | |
| def | idleOnline (self) |
| dummy (waits for state change) More... | |
| def | errorOffline (self) |
| action in response to an error while offline Sets the state to OFFLINE More... | |
| def | errorStandby (self) |
| action in response to an error while in standby Sets the state to OFFLINE More... | |
| def | errorOnline (self) |
| action in response to an error while online Sets the state to OFFLINE More... | |
| def | errorWorking (self) |
| action in response to an error while executing a command Sets the state to OFFLINE More... | |
Public Attributes | |
| worker | |
| Public Attributes inherited from BasdaService.Worker | |
| name | |
| worker | |
Detailed Description
A Python base class for a BASDA worker (executing a command).
Constructor & Destructor Documentation
◆ __init__() [1/2]
| def BasdaService.WorkerSkeleton.__init__ | ( | self, | |
| _svcName | |||
| ) |
◆ __init__() [2/2]
| def BasdaService.WorkerSkeleton.__init__ | ( | self, | |
| _svcName | |||
| ) |
Member Function Documentation
◆ cmdAction() [1/2]
| def BasdaService.WorkerSkeleton.cmdAction | ( | self, | |
| _i, | |||
| _str | |||
| ) |
declare the command be partially completed.
- Todo:
- what is the difference here relative to cmdPercent()
- Parameters
-
_i A percentage from 0 to 100 and -1 for "busy"
◆ cmdAction() [2/2]
| def BasdaService.WorkerSkeleton.cmdAction | ( | self, | |
| _i, | |||
| _str | |||
| ) |
declare the command be partially completed.
- Todo:
- what is the difference here relative to cmdPercent()
- Parameters
-
_i A percentage from 0 to 100 and -1 for "busy"
◆ cmdDone() [1/2]
| def BasdaService.WorkerSkeleton.cmdDone | ( | self | ) |
actions after terminating the command.
Essentially flags that the command is completed.
◆ cmdDone() [2/2]
| def BasdaService.WorkerSkeleton.cmdDone | ( | self | ) |
actions after terminating the command.
Essentially flags that the command is completed.
◆ cmdPercent() [1/2]
| def BasdaService.WorkerSkeleton.cmdPercent | ( | self, | |
| _i | |||
| ) |
declare the command be partially completed.
- Parameters
-
_i A percentage from 0 to 100 and -1 for "busy"
◆ cmdPercent() [2/2]
| def BasdaService.WorkerSkeleton.cmdPercent | ( | self, | |
| _i | |||
| ) |
declare the command be partially completed.
- Parameters
-
_i A percentage from 0 to 100 and -1 for "busy"
◆ cmdStart() [1/2]
| def BasdaService.WorkerSkeleton.cmdStart | ( | self, | |
| _str | |||
| ) |
initiate a command.
- Parameters
-
_str The name of the command to be started
◆ cmdStart() [2/2]
| def BasdaService.WorkerSkeleton.cmdStart | ( | self, | |
| _str | |||
| ) |
initiate a command.
- Parameters
-
_str The name of the command to be started
Member Data Documentation
◆ worker
| BasdaService.WorkerSkeleton.worker |
The documentation for this class was generated from the following file:
- /home/nirva/insroot/lib/python/site-packages/BasdaService.py
