### ===================================================================================================================
### NLKA tool - NLKA report
### ===================================================================================================================
# Copyright ©VIIA 2025
### ===================================================================================================================
### 1. Import modules
### ===================================================================================================================
# General imports
from __future__ import annotations
from typing import TYPE_CHECKING, List
# References for functions and classes in the rhdhv_fem package
from rhdhv_fem.fem_tools import fem_create_folder
# References for functions and classes in the viiaPackage
if TYPE_CHECKING:
from viiapackage.viiaStatus import ViiaProject
from viiapackage import installed_modules
# Import module fpdf, check if module is installed
# This module is used for the GUI for the NLKA assessment tool
if 'fpdf' in installed_modules:
from fpdf import FPDF
else:
FPDF = None
### ===================================================================================================================
### 2. NLKA Report
### ===================================================================================================================
[docs]class NLKA_Report(FPDF):
def __init__(self, project: ViiaProject, orientation: str = 'P', unit: str = 'mm', report_format: str = 'A4'):
""" Initiate the pdf document with the setup for the pdf."""
super().__init__(orientation=orientation, unit=unit, format=report_format)
self.project = project
self.title = ''
[docs] def add_title(self, title):
""" Add title to the pdf document."""
self.title = title
self.set_font('Arial', size=12)
self.cell(200, 10, txt=title, ln=1, align='L')
[docs] def create_pdf(self, name):
""" Create the pdf in the folder of the NSCE element."""
# Create the folder to store all the results
output_path = self.project.workfolder_location / 'NSCE Assessment' / f'{name}'
fem_create_folder(output_path)
# Create the result pdf
file_path = output_path / f'{self.title}.pdf'
self.output(file_path.as_posix())
[docs] def create_table_parameters(self, parameters: List, spacing=1.5):
""" Add the parameters into table in the pdf."""
self.set_font('Arial', size=8)
col_width_first_column = self.w / 4 * 2
col_width_number = self.w / 9
row_height = self.font_size
for row in parameters:
self.cell(col_width_first_column, row_height * spacing, txt=row[0], border=1)
for item in row[1:]:
self.cell(col_width_number, row_height * spacing, txt=item, border=1)
self.ln(row_height * spacing)
[docs] def create_table_results(self, parameters: List, spacing=1.5):
""" Add the results into table in the pdf."""
self.set_font("Arial", size=8)
# Create void between this and previous table
self.ln(self.h / 20)
col_width_first_column = self.w / 4 * 2
col_width_number = self.w / 9
row_height = self.font_size
for row in parameters:
self.cell(col_width_first_column, row_height * spacing, txt=row[0], border=1)
for item in row[1:]:
self.cell(col_width_number, row_height * spacing, txt=item, border=1)
self.ln(row_height * spacing)
def add_image(self, file):
self.image(file, w=self.w / 3, h=self.h / 6)
[docs]def viia_create_nlka_report(project: ViiaProject, orientation='P', unit='mm', report_format='A4'):
"""Function to create the report for NLKA assessment. """
if 'fpdf' not in installed_modules:
raise ModuleNotFoundError(
"ERROR: The NLKA assessment requires the module 'fpdf' to create a report. Function is aborted.")
# Create the instance for the NLKA assessment report
return NLKA_Report(project=project, orientation=orientation, unit=unit, report_format=report_format)
### ===================================================================================================================
### 3. End of script
### ===================================================================================================================