Inheritance diagram for python.hanwriter.Node:

Collaboration diagram for python.hanwriter.Node:

Public Member Functions
	__init__ (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)

Public Attributes
list	subnodes = None
dict	attributes = None
list	acceptChild
	nodeType = Node.UNKNOWN
	name = name

Detailed Description

This is the base class for each element that can be written in a valid han configuration file.
Attributes:
    - subnodes : a list of Node instances
    - attributes : a list of attributes associated with the node
    - acceptChild : a list of Node types that can be accepted as sub nodes
    - nodeType : the type of the node
    - name : the name of the node

Definition at line 48 of file hanwriter.py.

Constructor & Destructor Documentation

◆ init()

python.hanwriter.Node.__init__	(		self,
			name = '' )

Create a han node

Definition at line 61 of file hanwriter.py.

    def __init__(self, name=''):
        """
        Create a han node
        """
        self.subnodes = None
        self.attributes = None
        self.acceptChild = [Node.ALGORITHM, Node.DIR, Node.DOCUMENT, Node.HIST, Node.OUTPUT,
                            Node.REFERENCE, Node.THRESHOLD, Node.LIMIT, Node.COMPALG]
        self.nodeType = Node.UNKNOWN
        self.name = name
 

Member Function Documentation

◆ str()

python.hanwriter.Node.__str__ ( self )

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

◆ appendChild()

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

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]
 

◆ getAttribute()

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

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

◆ getSubNode()

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

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 )

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 )

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 )

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 )

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 = "" )

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

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

Definition at line 66 of file hanwriter.py.

◆ name

python.hanwriter.Node.name = name

Definition at line 70 of file hanwriter.py.

◆ nodeType

python.hanwriter.Node.nodeType = Node.UNKNOWN

Definition at line 69 of file hanwriter.py.

◆ subnodes

python.hanwriter.Node.subnodes = None

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