python.hanwriter.HanOutput Class Reference

Inheritance diagram for python.hanwriter.HanOutput:

Collaboration diagram for python.hanwriter.HanOutput:

Public Member Functions
def	__init__ (self, name, algorithm=None, father=None, annotations={}, attributes={})
def	getAlgorithm (self)
def	addOutput (self, name, algorithm, annotations, attributes)
def	getOutputPath (self, append=None, delimiter="/")
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
	acceptChild
	nodeType
	father
	subnodes
	attributes
	name

Detailed Description

Class representing a output element
A han output element is a Node with sub nodes of type output and with the optional attribute algorithm
attribute:
    - father: the HanOutput that contains this HanOutput

Definition at line 439 of file hanwriter.py.

Constructor & Destructor Documentation

__init__()

def python.hanwriter.HanOutput.__init__	(		self,
			name,
			algorithm = None,
			father = None,
			annotations = {},
			attributes = {}
	)

Creates an output han element

Definition at line 453 of file hanwriter.py.

    def __init__(self, name, algorithm=None, father=None, annotations={}, attributes={}):
        """
        Creates an output han element
        """
        Node.__init__(self, name)
        self.acceptChild = [Node.OUTPUT]
        self.nodeType = Node.OUTPUT
        if algorithm:
            self.setAttribute('algorithm', algorithm)
        self.father = father
        if 'Weight' in attributes:
            self.setAttribute('weight', attributes['Weight'][1])
        for annotation in annotations:
            self.setAttribute(annotation, annotations[annotation])
 

Member Function Documentation

__str__()

def python.hanwriter.Node.__str__ (   self )

inherited

Definition at line 192 of file hanwriter.py.

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

addOutput()

def python.hanwriter.HanOutput.addOutput	(		self,
			name,
			algorithm,
			annotations,
			attributes
	)

Adds a sub output element with name and algorithm

Reimplemented in python.hanwriter.Document.

Definition at line 483 of file hanwriter.py.

    def addOutput(self, name, algorithm, annotations, attributes):
        """
        Adds a sub output element with name and algorithm
        """
        subnode = HanOutput(name, algorithm, self, annotations, attributes)
        self.appendChild(subnode)
        return subnode

appendChild()

def python.hanwriter.Node.appendChild (   self,   child  )

inherited

Add a sub node to this node

Definition at line 128 of file hanwriter.py.

    def appendChild(self, child):
        """
        Add a sub node to this node
        """
        try:
            if child.nodeType not in self.acceptChild:
                msg = " Node: "+DQHanConfMaker._get_NodeType(self.nodeType)
                msg += " Cannot have a child of type:", child.nodeType
                raise HanCannotCreateConf(msg)
        except Exception:
            raise HanCannotCreateConf(
                "Object:"+str(child)+" is not a valid Node")
        if not self.subnodes:
            self.subnodes = []
        self.subnodes += [child]
 

getAlgorithm()

def python.hanwriter.HanOutput.getAlgorithm

(

self

)

Gets the algorithm attribute

Definition at line 470 of file hanwriter.py.

    def getAlgorithm(self):
        """
        Gets the algorithm attribute
        """
        if 'algorithm' in self.attributes:
            return self.getAttribute('algorithm')

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.

    def getAttribute(self, key):
        """
        Gets the attribute identified by the key, None if not found
        """
        if self.attributes and key in self.attributes:
            return self.attributes[key]
        return None

getOutputPath()

def python.hanwriter.HanOutput.getOutputPath	(		self,
			append = None,
			delimiter = "/"
	)

Creates the complete path of this output directory

Definition at line 495 of file hanwriter.py.

    def getOutputPath(self, append=None, delimiter="/"):
        """
        Creates the complete path of this output directory
        """
        name = self.name
        if append:
            name = name + append
        if self.father:
            name = self.father.getOutputPath(delimiter+name, delimiter)
        return name
 
# Class document
# This class represents the han document.
# This class is a set of nodes
 
 

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.

    def getSubNode(self, name, nodetype):
        """
        Returns the sub-node identified by name and nodetype
        """
        if self.subnodes:
            for sn in self.subnodes:
                if sn.nodeType == nodetype and sn.name == name:
                    return sn
        return None
 

removeAttribute()

def python.hanwriter.Node.removeAttribute (   self,   key  )

inherited

Removes attribute identified by key

Definition at line 158 of file hanwriter.py.

    def removeAttribute(self, key):
        """
        Removes attribute identified by key
        """
        if self.attributes and key in self.attributes:
            del self.attributes[key]
            return True
        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.

    def setAttribute(self, key, attribute):
        """
        The attribute identified by key is added to this node
        """
        if not self.attributes:
            self.attributes = {}
        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.

    def tohan(self, encoding=None):
        """
        convert the object in a valid han script block
        """
        return self.toprettyhan("", "", encoding)
 

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.

    def toprettyhan(self, indent="\t", newl="\n", encoding=None):
        """
        convert the object in a formatted han string
        """
        # restore the following in a future tdaq release
        # writer = DQHanConfMaker._get_StringIO()
        import io
        import six
        writer = io.BytesIO() if six.PY2 else io.StringIO()
        if encoding is not None:
            import codecs
            writer = codecs.lookup(encoding)[3](writer)
        self.writehan(writer, "", indent, newl)
        return writer.getvalue()
 

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.

    def writehan(self, writer, indent="", addindent="", newl=""):
        """
        Converts the object in a han string and writes it in the writer object
        """
        writer.write(
            indent+DQHanConfMaker._get_NodeType(self.nodeType)+" "+self.name)
        # if it is a document do not need to add { }
        if self.nodeType != Node.DOCUMENT:
            writer.write(" { %s" % (newl))
        if self.attributes:
            for key, attribute in self.attributes.items():
                writer.write("%s %s = %s%s" % (indent, key, attribute, newl))
        if self.subnodes:
            for node in self.subnodes:
                node.writehan(writer, indent+addindent, addindent, newl)
        if self.nodeType != Node.DOCUMENT:
            writer.write("%s}%s" % (indent, newl))
 

Member Data Documentation

acceptChild

python.hanwriter.HanOutput.acceptChild

Definition at line 458 of file hanwriter.py.

attributes

python.hanwriter.Node.attributes

inherited

Definition at line 67 of file hanwriter.py.

father

python.hanwriter.HanOutput.father

Definition at line 462 of file hanwriter.py.

name

python.hanwriter.Node.name

inherited

Definition at line 71 of file hanwriter.py.

nodeType

python.hanwriter.HanOutput.nodeType

Definition at line 459 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:

• hanwriter.py