Belle II Software  release-05-01-25
entities.py
2  """
3  Data class for an entry in a store content list.
4  """
5 
6  def __init__(self, name, number):
7  """
8  Create a new entry in a Store Content List.
9 
10  Parameters:
11  name: The name of the store content.
12  number: The number of items in this store content.
13  """
14 
15  self.name = name
16 
17  self.number = number
18 
19 
21  """
22  Data class for the content of the storage for one event.
23  """
24 
25  def __init__(self, content, event_number):
26  """
27  Create a new content fr one event.
28 
29  Parameters:
30  content: A list of StoreContents.
31  event_number: The event number this element describes.
32  """
33 
34  self.content = content
35 
36  self.event_number = event_number
37 
38 
40  """
41  Data class for a column in the statistics view.
42  """
43 
44  def __init__(self, name, display_name=None, three_column_format=False):
45  """
46  Create a new column for the statistics view.
47 
48  Parameters:
49  name: The name of this column.
50  display_name: The display name of this column.
51  three_column_format: If the column has one or three columns.
52  """
53 
54  self.name = name
55 
56  self.three_column_format = three_column_format
57 
58  if not display_name:
59 
60  self.display_name = self.name
61  else:
62 
63  self.display_name = display_name
64 
65 
66 class Statistics:
67  """
68  Data class for the statistics.
69  """
70 
71  def __init__(self, columns, modules):
72  """
73  Create a new Statistics object.
74 
75  Parameters:
76  columns: The list of StatisticsColumns.
77  modules: A list of dictionaries, each one with the same names as there are columns.
78  """
79 
80  self.columns = columns
81 
82  self.modules = modules
hep_ipython_tools.entities.StatisticsColumn
Definition: entities.py:39
hep_ipython_tools.entities.StatisticsColumn.name
name
The name of this column.
Definition: entities.py:54
hep_ipython_tools.entities.StoreContentList.event_number
event_number
The event number this element describes.
Definition: entities.py:36
hep_ipython_tools.entities.StoreContent.name
name
The name of the store content.
Definition: entities.py:15
hep_ipython_tools.entities.StatisticsColumn.__init__
def __init__(self, name, display_name=None, three_column_format=False)
Definition: entities.py:44
hep_ipython_tools.entities.Statistics.modules
modules
A list of dictionaries, each one with the same names as there are columns.
Definition: entities.py:82
hep_ipython_tools.entities.StoreContent.number
number
The number of items in this store content.
Definition: entities.py:17
hep_ipython_tools.entities.StoreContentList
Definition: entities.py:20
hep_ipython_tools.entities.StoreContent
Definition: entities.py:1
hep_ipython_tools.entities.Statistics
Definition: entities.py:66
hep_ipython_tools.entities.Statistics.__init__
def __init__(self, columns, modules)
Definition: entities.py:71
hep_ipython_tools.entities.StoreContentList.content
content
A list of StoreContents.
Definition: entities.py:34
hep_ipython_tools.entities.Statistics.columns
columns
The list of StatisticsColumns.
Definition: entities.py:80
hep_ipython_tools.entities.StoreContent.__init__
def __init__(self, name, number)
Definition: entities.py:6
hep_ipython_tools.entities.StoreContentList.__init__
def __init__(self, content, event_number)
Definition: entities.py:25
hep_ipython_tools.entities.StatisticsColumn.display_name
display_name
The name to show.
Definition: entities.py:60
hep_ipython_tools.entities.StatisticsColumn.three_column_format
three_column_format
If the column has one or three columns.
Definition: entities.py:56