IntelModule

class HSTB.kluster.fqpr_intelligence.IntelModule(**kwargs)

Bases: LoggerClass

Base module for the intelligence modules. Intelligence modules are classes that contain a specific kind of file, and have methods that are useful for that file type to determine which files go together and which files should be processed in to which date/time/sonarmodel container.

Contains the attribution that all other extended modules share as well as the basic adding/removing functionality.

Methods Summary

add_dict(attributes)	Add an incoming dictionary to the intelligence module, if it is not in there already and is a valid set
clear()	Reset the IntelModule by just reinitializing the attributes
remove_file(filepath)	remove the provided filepath from the intelligence module, returns the unique id for this file so that we can update the GUI if necessary

Methods Documentation

add_dict(attributes)

Add an incoming dictionary to the intelligence module, if it is not in there already and is a valid set

Parameters

attributes (OrderedDict) – attributes for the incoming file, see one of the gather_xxxx functions outside of the class

clear()

Reset the IntelModule by just reinitializing the attributes

remove_file(filepath)

remove the provided filepath from the intelligence module, returns the unique id for this file so that we can update the GUI if necessary

Parameters

filepath (str) – absolute file path for the file to remove

Returns

unique id for the file we removed, FqprIntel is generating the unique id

Return type

int