ATLAS Offline Software
Public Member Functions | Public Attributes | List of all members
python.hanwriter.HanLimit Class Reference
Inheritance diagram for python.hanwriter.HanLimit:
Collaboration diagram for python.hanwriter.HanLimit:

Public Member Functions

def __init__ (self, name, warning, error)
 
def tohan (self, encoding=None)
 
def toprettyhan (self, indent="\t", newl="\n", encoding=None)
 
def writehan (self, writer, indent="", addindent="", newl="")
 
def appendChild (self, child)
 
def setAttribute (self, key, attribute)
 
def removeAttribute (self, key)
 
def getAttribute (self, key)
 
def getSubNode (self, name, nodetype)
 
def __str__ (self)
 

Public Attributes

 nodeType
 
 acceptChild
 
 subnodes
 
 attributes
 
 name
 

Detailed Description

The han representation of a limit for a HanThreshold

Definition at line 329 of file hanwriter.py.

Constructor & Destructor Documentation

◆ __init__()

def python.hanwriter.HanLimit.__init__ (   self,
  name,
  warning,
  error 
)
Creates a han limit object

Definition at line 338 of file hanwriter.py.

338  def __init__(self, name, warning, error):
339  """
340  Creates a han limit object
341  """
342  Node.__init__(self, name)
343  self.nodeType = Node.LIMIT
344  self.acceptChild = []
345  self.setAttribute('warning', warning)
346  self.setAttribute('error', error)
347 
348 # Class for threshold
349 # This class implements the han representation of a DQThreshold
350 
351 

Member Function Documentation

◆ __str__()

def python.hanwriter.Node.__str__ (   self)
inherited

Definition at line 192 of file hanwriter.py.

192  def __str__(self):
193  return "HanNode: "+self.name+" ("+DQHanConfMaker._get_NodeType(self.nodeType)+") Attributes:"+str(self.attributes)+" SubNodes: "+str(self.subnodes)
194 
195 
196 # HanHistogram class
197 # This class represents the configuration for a histogram

◆ appendChild()

def python.hanwriter.Node.appendChild (   self,
  child 
)
inherited
Add a sub node to this node

Definition at line 128 of file hanwriter.py.

128  def appendChild(self, child):
129  """
130  Add a sub node to this node
131  """
132  try:
133  if child.nodeType not in self.acceptChild:
134  msg = " Node: "+DQHanConfMaker._get_NodeType(self.nodeType)
135  msg += " Cannot have a child of type:", child.nodeType
136  raise HanCannotCreateConf(msg)
137  except Exception:
138  raise HanCannotCreateConf(
139  "Object:"+str(child)+" is not a valid Node")
140  if not self.subnodes:
141  self.subnodes = []
142  self.subnodes += [child]
143 

◆ getAttribute()

def python.hanwriter.Node.getAttribute (   self,
  key 
)
inherited
Gets the attribute identified by the key, None if not found

Definition at line 170 of file hanwriter.py.

170  def getAttribute(self, key):
171  """
172  Gets the attribute identified by the key, None if not found
173  """
174  if self.attributes and key in self.attributes:
175  return self.attributes[key]
176  return None

◆ getSubNode()

def python.hanwriter.Node.getSubNode (   self,
  name,
  nodetype 
)
inherited
Returns the sub-node identified by name and nodetype

Definition at line 182 of file hanwriter.py.

182  def getSubNode(self, name, nodetype):
183  """
184  Returns the sub-node identified by name and nodetype
185  """
186  if self.subnodes:
187  for sn in self.subnodes:
188  if sn.nodeType == nodetype and sn.name == name:
189  return sn
190  return None
191 

◆ removeAttribute()

def python.hanwriter.Node.removeAttribute (   self,
  key 
)
inherited
Removes attribute identified by key

Definition at line 158 of file hanwriter.py.

158  def removeAttribute(self, key):
159  """
160  Removes attribute identified by key
161  """
162  if self.attributes and key in self.attributes:
163  del self.attributes[key]
164  return True
165  return False

◆ setAttribute()

def python.hanwriter.Node.setAttribute (   self,
  key,
  attribute 
)
inherited
The attribute identified by key is added to this node

Definition at line 147 of file hanwriter.py.

147  def setAttribute(self, key, attribute):
148  """
149  The attribute identified by key is added to this node
150  """
151  if not self.attributes:
152  self.attributes = {}
153  self.attributes[key] = attribute

◆ tohan()

def python.hanwriter.Node.tohan (   self,
  encoding = None 
)
inherited
convert the object in a valid han script block

Definition at line 76 of file hanwriter.py.

76  def tohan(self, encoding=None):
77  """
78  convert the object in a valid han script block
79  """
80  return self.toprettyhan("", "", encoding)
81 

◆ toprettyhan()

def python.hanwriter.Node.toprettyhan (   self,
  indent = "\t",
  newl = "\n",
  encoding = None 
)
inherited
convert the object in a formatted han string

Definition at line 87 of file hanwriter.py.

87  def toprettyhan(self, indent="\t", newl="\n", encoding=None):
88  """
89  convert the object in a formatted han string
90  """
91  # restore the following in a future tdaq release
92  # writer = DQHanConfMaker._get_StringIO()
93  import io
94  import six
95  writer = io.BytesIO() if six.PY2 else io.StringIO()
96  if encoding is not None:
97  import codecs
98  writer = codecs.lookup(encoding)[3](writer)
99  self.writehan(writer, "", indent, newl)
100  return writer.getvalue()
101 

◆ writehan()

def python.hanwriter.Node.writehan (   self,
  writer,
  indent = "",
  addindent = "",
  newl = "" 
)
inherited
Converts the object in a han string and writes it in the writer object

Definition at line 107 of file hanwriter.py.

107  def writehan(self, writer, indent="", addindent="", newl=""):
108  """
109  Converts the object in a han string and writes it in the writer object
110  """
111  writer.write(
112  indent+DQHanConfMaker._get_NodeType(self.nodeType)+" "+self.name)
113  # if it is a document do not need to add { }
114  if self.nodeType != Node.DOCUMENT:
115  writer.write(" { %s" % (newl))
116  if self.attributes:
117  for key, attribute in self.attributes.items():
118  writer.write("%s %s = %s%s" % (indent, key, attribute, newl))
119  if self.subnodes:
120  for node in self.subnodes:
121  node.writehan(writer, indent+addindent, addindent, newl)
122  if self.nodeType != Node.DOCUMENT:
123  writer.write("%s}%s" % (indent, newl))
124 

Member Data Documentation

◆ acceptChild

python.hanwriter.HanLimit.acceptChild

Definition at line 344 of file hanwriter.py.

◆ attributes

python.hanwriter.Node.attributes
inherited

Definition at line 67 of file hanwriter.py.

◆ name

python.hanwriter.Node.name
inherited

Definition at line 71 of file hanwriter.py.

◆ nodeType

python.hanwriter.HanLimit.nodeType

Definition at line 343 of file hanwriter.py.

◆ subnodes

python.hanwriter.Node.subnodes
inherited

Definition at line 66 of file hanwriter.py.


The documentation for this class was generated from the following file:
TrigJetMonitorAlgorithm.items
items
Definition: TrigJetMonitorAlgorithm.py:79
python.processes.powheg.ZZ.ZZ.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ZZ.py:18
str
Definition: BTagTrackIpAccessor.cxx:11