Report Utility
Class “ReportUtility” for PDF Reports
Quick Facts
| Property | Value |
|---|---|
| Class | ReportUtility |
| Module | cenpylib.ReportUtility |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 52 |
| Inherits from | FPDF |
Inheritance
Quick Start
# Boilerplate Example
obj = ReportUtility()Lifecycle
| Method | Returns | Summary |
|---|---|---|
__init__ | — | Initialization |
createAutoExecutePDFReport | — | Pass Command from AutoExecute, e.g. |
createAuxCommandsPDFReport | — | Pass Command from Program Dashboard’s “Auxiliary Commands” |
createPDFReport | — | Main Method to create the PDF Report |
createDialogueUI | — | Create the window elements and functions. |
Query Methods
| Method | Returns | Summary |
|---|---|---|
getCurrencyCode | — | Returns the Ascii Code of the desired Currency |
getRGBColours | — | Get the RGB Colours for the Table Header Row. |
getSpeedEvent | — | Calculates linear tool path length |
getTechnoEvent | — | Calculates linear tool path length |
getAccuracyEvent | — | Calculates linear tool path length |
getMotionTypeString | — | Get the Motion Type of the TPE (PTP, LIN, CIR) |
getCollisionReachabilityString | — | Get the Colloision and/or Reachability of the TPE, |
getVariousField | — | Template, …might be inheritate for own desired Information in PlugIn Script |
getVector | — | Gets vector through two points |
getVectorLength | — | Calculates vector length |
getVectorScalar | — | Calculates vector scalar |
getReportLocation | — | Calls the Folder select dialog |
getsetValues | — | read or write |
Mutation Methods
| Method | Returns | Summary |
|---|---|---|
setCosts | — | Sets the Costs per Meter |
setCurrency | — | Sets the desired Currency |
setLanguage | — | Sets the desired Language |
setHeaderLogo | — | Sets the Logo shown on Reports top/right |
setFooterLogo | — | Sets the Logo shown on Reports bottom/left |
Execution & Actions
| Method | Returns | Summary |
|---|---|---|
buildReportName | — | Build Report File Name, to be inheritate if customizing desired. |
calculateCosts | — | Calculates Costs per TPE dependent to TechnoState, MotionType, etc. |
Utilities
| Method | Returns | Summary |
|---|---|---|
defineFont | — | Defines the desired Font Type and size to Globals. |
defineColumnTitleWidth | — | Defines the Order of the desired Table Columns. |
defineColName | — | — |
defineColMotionType | — | — |
defineColLength | — | — |
defineColSpeed | — | — |
defineColTime | — | — |
defineColCosts | — | — |
defineColCollReach | — | — |
defineColEvents | — | — |
defineColVarious | — | — |
header | — | Defines the common Header of the PDF Report, called from FPDF Base Class |
cenheader | — | Defines the customized Header of the PDF Report, underneath common Header |
cenfooter | — | Defines the customized Footer of the PDF Report, underneath common Header |
footer | — | Defines the common Footer of the PDF Report, called from FPDF Base Class |
body | — | Defines the customized Body of the PDF Report. |
collectelements | — | Collect all the necessary Information from the Program and writes it to a List |
columnOrder | — | Sorts the complete Range of Columns to the desired Order of the single Columns |
header_table | — | Write a Table with common Program Information |
intermediateBlockBefore | — | Anything between CenHeader and TPE List (Template for Inheritance) |
intermediateBlockAfter | — | Anything between TPE List and CenFooter (Template for Inheritance) |
colored_table | — | Write the Program TPEs Information to the Table |
technoEventsExist | — | Calculates linear tool path length |
calcLinLength | — | Calculates linear tool path length |
calcCircLength | — | Calculates circular tool path length |
saveReportAs | — | Calls the usual file save dialog |
extendedSaveUI | — | extended File Save dialogue with Costs Settings |
Related Types
Version Notes
This class is documented as of release R2026.1.1.
Was this page helpful?