module.template_module.BoswatchModule Class Reference

Description of the Module. More...

Public Member Functions
	__init__ (self, config)
	Do not change anything here!
	onLoad (self)
	Called by import of the plugin Remove if not implemented.
	doWork (self, bwPacket)
	start an run of the module.
	onUnload (self)
	Called by destruction of the plugin Remove if not implemented.

Additional Inherited Members
Static Public Member Functions inherited from module.moduleBase.ModuleBase
	registerWildcard (newWildcard, bwPacketField)
	Register a new wildcard.
Data Fields inherited from module.moduleBase.ModuleBase
	config
Protected Member Functions inherited from module.moduleBase.ModuleBase
	_cleanup (self)
	Cleanup routine calls onUnload() directly.
	_run (self, bwPacket)
	start an run of the module.
	_getStatistics (self)
	Returns statistical information's from last module run.
Protected Attributes inherited from module.moduleBase.ModuleBase
	_moduleName
	_cumTime
	_moduleTime
	_runCount
	_moduleErrorCount
Static Protected Attributes inherited from module.moduleBase.ModuleBase
list	_modulesActive = []

Detailed Description

Description of the Module.

Constructor & Destructor Documentation

__init__()

module.template_module.BoswatchModule.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from module.moduleBase.ModuleBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

onLoad()

module.template_module.BoswatchModule.onLoad

(

self

)

Called by import of the plugin Remove if not implemented.

Reimplemented from module.moduleBase.ModuleBase.

    def onLoad(self):
        r"""!Called by import of the plugin
        Remove if not implemented"""
        pass
 

doWork()

module.template_module.BoswatchModule.doWork	(		self,
			bwPacket
	)

start an run of the module.

Parameters

bwPacket

A BOSWatch packet instance

Reimplemented from module.moduleBase.ModuleBase.

    def doWork(self, bwPacket):
        r"""!start an run of the module.
 
        @param bwPacket: A BOSWatch packet instance"""
        if bwPacket.get("mode") == "fms":
            pass
        elif bwPacket.get("mode") == "zvei":
            pass
        elif bwPacket.get("mode") == "pocsag":
            pass
        elif bwPacket.get("mode") == "msg":
            pass
 
        return bwPacket
 

onUnload()

module.template_module.BoswatchModule.onUnload

(

self

)

Called by destruction of the plugin Remove if not implemented.

Reimplemented from module.moduleBase.ModuleBase.

    def onUnload(self):
        r"""!Called by destruction of the plugin
        Remove if not implemented"""
        pass