params.py

Go to the documentation of this file.

#!/usr/bin/env python
#
# Copyright 2015 Airbus
# Copyright 2017 Fraunhofer Institute for Manufacturing Engineering and Automation (IPA)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from airbus_docgen.common import html
from airbus_docgen.common.html import HtmlElement
from airbus_docgen.digraph.digraph import *
from airbus_docgen.digraph.model.topic import getStandardTDModel


class NodeParameters(HtmlElement):
    
    def __init__(self):
        HtmlElement.__init__(self,
                             tag=html.Sections.article,
                             attrib={"class":"parameters"})
        
    def read(self, node_name, node_xml):
        
        has_params = False
        node_params = node_xml.find("parameters")
        
        if node_params.find("param") is not None:
        
            table = TABLE()
            
            title = TD()
            title.setAttrib(TD.ALIGN, ALIGN.Center)
            title.setAttrib(TD.COLSPAN, 5)
            title.setText("Launch parameters")
            table.addTR(TR(title))
            
            ptr = TR()
            ptr.addTD(getStandardTDModel("Name",        bgcolor=RgbColor.White, align=ALIGN.Center))
            ptr.addTD(getStandardTDModel("Type",        bgcolor=RgbColor.White, align=ALIGN.Center))
            ptr.addTD(getStandardTDModel("Default",     bgcolor=RgbColor.White, align=ALIGN.Center))
            ptr.addTD(getStandardTDModel("Unit",        bgcolor=RgbColor.White, align=ALIGN.Center))
            ptr.addTD(getStandardTDModel("Description", bgcolor=RgbColor.White, align=ALIGN.Center))
            table.addTR(ptr)
            
            for param in node_params.iter('param'):
                
                ptr = TR()
                
                ptr.addTD(getStandardTDModel(self.get_pattrib(param, 'name'),
                                             bgcolor=RgbColor.White,
                                             align = ALIGN.Left))
                
                ptr.addTD(getStandardTDModel(self.get_pattrib(param, "type"),
                                             bgcolor=RgbColor.White,
                                             align = ALIGN.Center))
                
                ptr.addTD(getStandardTDModel(self.get_pattrib(param, "default"),
                                             bgcolor=RgbColor.White,
                                             align = ALIGN.Center))
                
                ptr.addTD(getStandardTDModel(self.get_pattrib(param, "unit"),
                                             bgcolor=RgbColor.White,
                                             align = ALIGN.Center))
                
                ptr.addTD(getStandardTDModel(str(param.text),
                                             bgcolor=RgbColor.White,
                                             align=ALIGN.Left))
                
                table.addTR(ptr)
                has_params = True
            
            if has_params is True:
                self.append(table)
        
        return has_params
    
    def get_pattrib(self, param, key):
        
        if key in param.attrib:
            return param.attrib[key]
        else:
            return "None"