DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
cider.data_structures.structured_configuration.StructuredConfiguration Class Reference

Public Member Functions

 __init__ (self, str configuration_file_name)
 
ConfigurationHandler configuration_handler (self)
 
RelationalGraph relational_graph (self)
 

Protected Attributes

 _configuration_handler = ConfigurationHandler(configuration_file_name)
 
 _relational_graph = RelationalGraph(self._configuration_handler)
 

Detailed Description

Definition at line 8 of file structured_configuration.py.

Constructor & Destructor Documentation

◆ __init__()

cider.data_structures.structured_configuration.StructuredConfiguration.__init__ ( self,
str configuration_file_name )
Structured configuration object, essentially a wrapper around a 
ConfigurationHandler object and a RelationalGraph object. 

Provides access to both the configuration and its relational structure

Arguments:
    configuration_file_name -- name of the configuration .database.xml file to open

Definition at line 9 of file structured_configuration.py.

9 def __init__(self, configuration_file_name: str):
10 """Structured configuration object, essentially a wrapper around a
11 ConfigurationHandler object and a RelationalGraph object.
12
13 Provides access to both the configuration and its relational structure
14
15 Arguments:
16 configuration_file_name -- name of the configuration .database.xml file to open
17 """
18 self._configuration_handler = ConfigurationHandler(configuration_file_name)
19 self._relational_graph = RelationalGraph(self._configuration_handler)
20

Member Function Documentation

◆ configuration_handler()

ConfigurationHandler cider.data_structures.structured_configuration.StructuredConfiguration.configuration_handler ( self)

Definition at line 22 of file structured_configuration.py.

22 def configuration_handler(self)->ConfigurationHandler:
23 return self._configuration_handler
24

◆ relational_graph()

RelationalGraph cider.data_structures.structured_configuration.StructuredConfiguration.relational_graph ( self)

Definition at line 26 of file structured_configuration.py.

26 def relational_graph(self)->RelationalGraph:
27 return self._relational_graph
28

Member Data Documentation

◆ _configuration_handler

cider.data_structures.structured_configuration.StructuredConfiguration._configuration_handler = ConfigurationHandler(configuration_file_name)
protected

Definition at line 18 of file structured_configuration.py.

◆ _relational_graph

cider.data_structures.structured_configuration.StructuredConfiguration._relational_graph = RelationalGraph(self._configuration_handler)
protected

Definition at line 19 of file structured_configuration.py.


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