Inheritance diagram for python.folders.DefectsDBFoldersMixin:

Collaboration diagram for python.folders.DefectsDBFoldersMixin:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

Public Member Functions
None	__init__ (self)
cool.IFolderSet	parent_folderset (self)
cool.IFolder	defects_folder (self)
cool.IFolder	defect_logic_folder (self)

Protected Member Functions
None	_clear_connections (self)
Tuple[cool.IFolder, cool.Record]	_load_folder (self, folder, create_function)
None	_load_defects_folder (self)
cool.IFolder	_create_defects_folder (self, cool.IDatabase db)
None	_load_defect_logic_folder (self)
cool.IFolder	_create_defect_logic_folder (self, cool.IDatabase db)

Protected Attributes
	_defects_folder = None
	_defect_logic_folder = None
	_parent_folderset = None
list	_connections = []
	_create
	_defect_payload = res
	_defect_logic_payload = res

Detailed Description

This mixin contains code for managing the defect folders

Definition at line 17 of file folders.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Constructor & Destructor Documentation

◆ init()

None python.folders.DefectsDBFoldersMixin.__init__ ( self )

Definition at line 22 of file folders.py.

    def __init__(self) -> None:
        self._defects_folder = None
        self._defect_logic_folder = None
        self._parent_folderset = None
        self._connections = []
        super(DefectsDBFoldersMixin, self).__init__()
        

Member Function Documentation

◆ _clear_connections()

None python.folders.DefectsDBFoldersMixin._clear_connections ( self )

protected

Definition at line 29 of file folders.py.

    def _clear_connections(self) -> None:
        log.debug("DefectsDB connections cleared")
        for connection in self._connections:
            connection.closeDatabase()
        self._connections = []
    

◆ _create_defect_logic_folder()

cool.IFolder python.folders.DefectsDBFoldersMixin._create_defect_logic_folder	(		self,
		cool.IDatabase	db )

protected

Creates the COOL database/folder for virtual defect logic, if they don't exist.
Internal - use create=True in the constructor to create the COOL folder.

Definition at line 115 of file folders.py.

    def _create_defect_logic_folder(self, db: cool.IDatabase) -> cool.IFolder:
        """
        Creates the COOL database/folder for virtual defect logic, if they don't exist.
        Internal - use create=True in the constructor to create the COOL folder.
        """
        log.info("Creating defect logic folder")
        
        record_spec = cool.RecordSpecification()
        record_spec.extend("clauses", ST.String4k)
        
        folder_spec = cool.FolderSpecification(FV.MULTI_VERSION, record_spec)
        return db.createFolder(DEFECT_LOGIC_FOLDER, folder_spec, 
                               DEFECT_LOGIC_FOLDER_DESC, True)

◆ _create_defects_folder()

cool.IFolder python.folders.DefectsDBFoldersMixin._create_defects_folder	(		self,
		cool.IDatabase	db )

protected

Creates the COOL database/folder for defects, if they don't exist.
Internal - use create=True in the constructor to create the COOL folder.

Definition at line 82 of file folders.py.

    def _create_defects_folder(self, db: cool.IDatabase) -> cool.IFolder:
        """
        Creates the COOL database/folder for defects, if they don't exist.
        Internal - use create=True in the constructor to create the COOL folder.
        """
        log.info("Creating defects folder")
        
        record_spec = cool.RecordSpecification()
        record_spec.extend("present",     ST.Bool)
        record_spec.extend("recoverable", ST.Bool)
        record_spec.extend("user",        ST.String255)
        record_spec.extend("comment",     ST.String255)
                
        folder_spec = cool.FolderSpecification(FV.MULTI_VERSION, record_spec)
        return db.createFolder(DEFECTS_FOLDER, folder_spec, 
                                DEFECT_FOLDER_DESC, True)
                                

◆ _load_defect_logic_folder()

None python.folders.DefectsDBFoldersMixin._load_defect_logic_folder ( self )

protected

Internal function for populating the self._defect_logic_folder variable

Definition at line 107 of file folders.py.

    def _load_defect_logic_folder(self) -> None:
        """
        Internal function for populating the self._defect_logic_folder variable
        """        
        res = self._load_folder(DEFECT_LOGIC_FOLDER, 
                                self._create_defect_logic_folder)
        self._defect_logic_folder, self._defect_logic_payload = res
        

◆ _load_defects_folder()

None python.folders.DefectsDBFoldersMixin._load_defects_folder ( self )

protected

Internal function for populating the self._defects_folder variable

Definition at line 74 of file folders.py.

    def _load_defects_folder(self) -> None:
        """
        Internal function for populating the self._defects_folder variable
        """
        log.debug("Loading defects folder")
        res = self._load_folder(DEFECTS_FOLDER, self._create_defects_folder)
        self._defects_folder, self._defect_payload = res
    

◆ _load_folder()

Tuple[cool.IFolder, cool.Record] python.folders.DefectsDBFoldersMixin._load_folder	(	self,
		folder,
		create_function )

protected

Internal function used to load a COOL folder

Definition at line 46 of file folders.py.

    def _load_folder(self, folder, create_function) -> Tuple[cool.IFolder, cool.Record]:
        """
        Internal function used to load a COOL folder
        """
        db_folder_string = "%s::%s" % (self.connection_string, folder)
    
        if not self._create:
            create_function = None
    
        db, folder = Databases.get_folder(db_folder_string, 
                                          read_only=self._read_only,
                                          create_function=create_function,
                                          also_db=True)
        
        self._connections.append(db)
        
        payload = cool.Record(folder.payloadSpecification())
        
        return folder, payload
        

◆ defect_logic_folder()

cool.IFolder python.folders.DefectsDBFoldersMixin.defect_logic_folder ( self )

Returns the folder containing the virtual defect logic, loading it if necessary

Definition at line 100 of file folders.py.

    def defect_logic_folder(self) -> cool.IFolder:
        """
        Returns the folder containing the virtual defect logic, loading it if necessary
        """
        if self._defect_logic_folder is None: self._load_defect_logic_folder()
        return self._defect_logic_folder
    

◆ defects_folder()

cool.IFolder python.folders.DefectsDBFoldersMixin.defects_folder ( self )

Returns the folder containing the defects, loading it if necessary

Definition at line 67 of file folders.py.

    def defects_folder(self) -> cool.IFolder:
        """
        Returns the folder containing the defects, loading it if necessary
        """
        if self._defects_folder is None: self._load_defects_folder()
        return self._defects_folder
    

◆ parent_folderset()

cool.IFolderSet python.folders.DefectsDBFoldersMixin.parent_folderset ( self )

Lazy-loads parent folderset (useful for heirarchical tag manipulation)

Definition at line 36 of file folders.py.

    def parent_folderset(self) -> cool.IFolderSet:
        """
        Lazy-loads parent folderset (useful for heirarchical tag manipulation)
        """
        if self._parent_folderset is None:
            db = Databases.get_instance(self.connection_string, 
                                        read_only=self._read_only)
            self._parent_folderset = db.getFolderSet(PARENT_FOLDERSET)
        return self._parent_folderset
    

Member Data Documentation

◆ _connections

list python.folders.DefectsDBFoldersMixin._connections = []

protected

Definition at line 26 of file folders.py.

◆ _create

python.folders.DefectsDBFoldersMixin._create

protected

Definition at line 52 of file folders.py.

◆ _defect_logic_folder

python.folders.DefectsDBFoldersMixin._defect_logic_folder = None

protected

Definition at line 24 of file folders.py.

◆ _defect_logic_payload

python.folders.DefectsDBFoldersMixin._defect_logic_payload = res

protected

Definition at line 113 of file folders.py.

◆ _defect_payload

python.folders.DefectsDBFoldersMixin._defect_payload = res

protected

Definition at line 80 of file folders.py.

◆ _defects_folder

python.folders.DefectsDBFoldersMixin._defects_folder = None

protected

Definition at line 23 of file folders.py.

◆ _parent_folderset

python.folders.DefectsDBFoldersMixin._parent_folderset = None

protected

Definition at line 25 of file folders.py.

The documentation for this class was generated from the following file:

folders.py

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _clear_connections()

◆ _create_defect_logic_folder()

◆ _create_defects_folder()

◆ _load_defect_logic_folder()

◆ _load_defects_folder()

◆ _load_folder()

◆ defect_logic_folder()

◆ defects_folder()

◆ parent_folderset()

Member Data Documentation

◆ _connections

◆ _create

◆ _defect_logic_folder

◆ _defect_logic_payload

◆ _defect_payload

◆ _defects_folder

◆ _parent_folderset

◆ init()