Inheritance diagram for python.hanwriter.Document:

Collaboration diagram for python.hanwriter.Document:

Public Member Functions
	__init__ (self, top_level_algorithm='WorstCaseSummary')
	addOutput (self, name, algorithm, annotations={}, attributes={})
	getAlgorithm (self, name)
	getReference (self, name)
	addSubDir (self, name)
	addHistogram (self, histogram, algorithm, annotations={}, output=DQHanConfMaker._default_output, attributes={})
	getSubDir (self, name)
	tohan (self, encoding=None)
	toprettyhan (self, indent="\t", newl="\n", encoding=None)
	writehan (self, writer, indent="", addindent="", newl="")
	appendChild (self, child)
	setAttribute (self, key, attribute)
	removeAttribute (self, key)
	getAttribute (self, key)
	getSubNode (self, name, nodetype)
	__str__ (self)
	getOutputPath (self, append=None, delimiter="/")

Public Attributes
	root_output_level = HanOutput('top_level', top_level_algorithm)
list	subnodes = None
dict	attributes = None
list	acceptChild
	nodeType = Node.UNKNOWN
	name = name
	father = father

Detailed Description

Class representing a han document

Definition at line 509 of file hanwriter.py.

Constructor & Destructor Documentation

◆ init()

python.hanwriter.Document.__init__	(		self,
			top_level_algorithm = 'WorstCaseSummary' )

Creates an empty han document with a top level output

Definition at line 516 of file hanwriter.py.

    def __init__(self, top_level_algorithm='WorstCaseSummary'):
        """
        Creates an empty han document with a top level output
        """
        HanDir.__init__(self, '')
        HanOutput.__init__(self, '')
        self.nodeType = Node.DOCUMENT
        self.acceptChild = [Node.ALGORITHM, Node.DIR, Node.HIST, Node.OUTPUT, Node.REFERENCE, Node.THRESHOLD,
                            Node.COMPALG]
        self.root_output_level = HanOutput('top_level', top_level_algorithm)
        self.appendChild(self.root_output_level)

Member Function Documentation

◆ str()

python.hanwriter.Node.__str__ ( self )

inherited

Definition at line 190 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

◆ addHistogram()

python.hanwriter.HanDir.addHistogram	(	self,
		histogram,
		algorithm,
		annotations = {},
		output = DQHanConfMaker._default_output,
		attributes = {} )

inherited

Adds to the directory a histogram specifying the histogram name, the algorithm and the output path.

Definition at line 416 of file hanwriter.py.

    def addHistogram(self, histogram, algorithm, annotations={}, output=DQHanConfMaker._default_output, attributes={}):
        """
        Adds to the directory a histogram specifying the histogram name, the algorithm and the output path.
        """
        histo = HanHistogram(histogram, algorithm,
                             annotations, output, attributes)
        self.appendChild(histo)
        return histo

◆ addOutput()

python.hanwriter.Document.addOutput	(	self,
		name,
		algorithm,
		annotations = {},
		attributes = {} )

Adds a sub output element with name and algorithm

Reimplemented from python.hanwriter.HanOutput.

Definition at line 534 of file hanwriter.py.

    def addOutput(self, name, algorithm, annotations={}, attributes={}):
        """
        Adds a sub output element with name and algorithm
        """
        # forward to root region
        return HanOutput.addOutput(self.root_output_level, name, algorithm, annotations, attributes)

◆ addSubDir()

python.hanwriter.HanDir.addSubDir	(		self,
			name )

inherited

Adds a subdirectory called name to the current directory and returns the newly created sub directory

Definition at line 401 of file hanwriter.py.

    def addSubDir(self, name):
        """
        Adds a subdirectory called name to the current directory and returns the newly created sub directory
        """
        subdir = HanDir(name)
        self.appendChild(subdir)
        return subdir

◆ appendChild()

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

inherited

Add a sub node to this node

Definition at line 126 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()

python.hanwriter.Document.getAlgorithm	(		self,
			name )

retrieves the algorithm han object associated with name

Reimplemented from python.hanwriter.HanOutput.

Definition at line 544 of file hanwriter.py.

    def getAlgorithm(self, name):
        """
        retrieves the algorithm han object associated with name
        """
        return self.getSubNode(name, Node.ALGORITHM)

◆ getAttribute()

python.hanwriter.Node.getAttribute	(		self,
			key )

inherited

Gets the attribute identified by the key, None if not found

Definition at line 168 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()

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

inherited

Creates the complete path of this output directory

Definition at line 493 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
 
 

◆ getReference()

python.hanwriter.Document.getReference	(		self,
			name )

retrieves the han reference associated with name

Definition at line 553 of file hanwriter.py.

    def getReference(self, name):
        """
        retrieves the han reference associated with name
        """
        return self.getSubNode(name, Node.REFERENCE)
 
 
# Add a DQParameter object to the HanDocument
# @param handocument: the document containing the configuration @c handocument: a HanDocument object
# @param dqparameter: the DQParameter object @c dqparameter: a DQParameter object
# @param output: the output element for the result
# @note: This function is used internally and should not be used by users of this module

◆ getSubDir()

python.hanwriter.HanDir.getSubDir	(		self,
			name )

inherited

returns the sub-directory called name

Definition at line 427 of file hanwriter.py.

    def getSubDir(self, name):
        """
        returns the sub-directory called name
        """
        return self.getSubNode(name, Node.DIR)
 
# Class for han output
# This class implements the han output
 
 

◆ getSubNode()

python.hanwriter.Node.getSubNode	(	self,
		name,
		nodetype )

inherited

Returns the sub-node identified by name and nodetype

Definition at line 180 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()

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

inherited

Removes attribute identified by key

Definition at line 156 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()

python.hanwriter.Node.setAttribute	(	self,
		key,
		attribute )

inherited

The attribute identified by key is added to this node

Definition at line 145 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()

python.hanwriter.Node.tohan	(		self,
			encoding = None )

inherited

convert the object in a valid han script block

Definition at line 75 of file hanwriter.py.

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

◆ toprettyhan()

python.hanwriter.Node.toprettyhan	(	self,
		indent = "\t",
		newl = "\n",
		encoding = None )

inherited

convert the object in a formatted han string

Definition at line 86 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
        writer = io.StringIO()
        if encoding is not None:
            import codecs
            writer = codecs.lookup(encoding)[3](writer)
        self.writehan(writer, "", indent, newl)
        return writer.getvalue()
 

◆ writehan()

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 105 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

list python.hanwriter.Node.acceptChild

inherited

Initial value:

= [Node.ALGORITHM, Node.DIR, Node.DOCUMENT, Node.HIST, Node.OUTPUT,

Node.REFERENCE, Node.THRESHOLD, Node.LIMIT, Node.COMPALG]

Definition at line 67 of file hanwriter.py.

◆ attributes

python.hanwriter.Node.attributes = None

inherited

Definition at line 66 of file hanwriter.py.

◆ father

python.hanwriter.HanOutput.father = father

inherited

Definition at line 460 of file hanwriter.py.

◆ name

python.hanwriter.Node.name = name

inherited

Definition at line 70 of file hanwriter.py.

◆ nodeType

python.hanwriter.Node.nodeType = Node.UNKNOWN

inherited

Definition at line 69 of file hanwriter.py.

◆ root_output_level

python.hanwriter.Document.root_output_level = HanOutput('top_level', top_level_algorithm)

Definition at line 525 of file hanwriter.py.

◆ subnodes

python.hanwriter.Node.subnodes = None

inherited

Definition at line 65 of file hanwriter.py.

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

hanwriter.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __str__()

◆ addHistogram()

◆ addOutput()

◆ addSubDir()

◆ appendChild()

◆ getAlgorithm()

◆ getAttribute()

◆ getOutputPath()

◆ getReference()

◆ getSubDir()

◆ getSubNode()

◆ removeAttribute()

◆ setAttribute()

◆ tohan()

◆ toprettyhan()

◆ writehan()

Member Data Documentation

◆ acceptChild

◆ attributes

◆ father

◆ name

◆ nodeType

◆ root_output_level

◆ subnodes

◆ init()

◆ str()