Report Utility — Utilities
Back to Report Utility.
defineFont
def defineFont()Defines the desired Font Type and size to Globals. Note : CN & JP are only supported by one unique Font, Size can be adjusted
defineColumnTitleWidth
def defineColumnTitleWidth(columns)Defines the Order of the desired Table Columns. Note: internal Column Name and its Place in the Order must be fix
Parameters:
| Name | Type | Description |
|---|---|---|
columns | — | the desired List of Columns in desired Order |
defineColName
def defineColName()defineColMotionType
def defineColMotionType()defineColLength
def defineColLength()defineColSpeed
def defineColSpeed()defineColTime
def defineColTime()defineColCosts
def defineColCosts()defineColCollReach
def defineColCollReach()defineColEvents
def defineColEvents()defineColVarious
def defineColVarious()header
def header()Defines the common Header of the PDF Report, called from FPDF Base Class
cenheader
def cenheader(Operator, path, portrLands)Defines the customized Header of the PDF Report, underneath common Header
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
path | — | the Location of the Caller Script. Needed to find the Images |
portrLands | — | if Report is created in Portrait or Landscape Mode |
cenfooter
def cenfooter(path, portrLands)Defines the customized Footer of the PDF Report, underneath common Header
Parameters:
| Name | Type | Description |
|---|---|---|
path | — | the Location of the Caller Script. Needed to find the Images |
portrLands | — | if Report is created in Portrait or Landscape Mode |
footer
def footer()Defines the common Footer of the PDF Report, called from FPDF Base Class
body
def body(Operator, headLine, colWidths, order)Defines the customized Body of the PDF Report.
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
headLine | — | the List of the Columns Header Names |
colWidths | — | the List of the Columns Width |
order | — | the List of the ordered Column Numbers |
collectelements
def collectelements(Operator, order, costPerMeter)Collect all the necessary Information from the Program and writes it to a List
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
order | — | the List of the ordered Column Numbers |
costPerMeter | — | the Value of the Costs per Meter |
columnOrder
def columnOrder(order, unsorted)Sorts the complete Range of Columns to the desired Order of the single Columns
Parameters:
| Name | Type | Description |
|---|---|---|
order | — | the numeric List of the desired Order |
unsorted | — | the complete Range of Information per TPE |
header_table
def header_table(Operator)Write a Table with common Program Information
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
intermediateBlockBefore
def intermediateBlockBefore(Operator, paramList)Anything between CenHeader and TPE List (Template for Inheritance)
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
paramList | — | the List of used Parameters |
intermediateBlockAfter
def intermediateBlockAfter(Operator, paramList)Anything between TPE List and CenFooter (Template for Inheritance)
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
paramList | — | the List of used Parameters |
colored_table
def colored_table(headings, rows, colWidths)Write the Program TPEs Information to the Table
Parameters:
| Name | Type | Description |
|---|---|---|
headings | — | the List of the Table Header |
rows | — | the List of the TPE Information |
colWidths | — | the List of the Column Width |
technoEventsExist
def technoEventsExist(eventHandler, opTpes)Calculates linear tool path length
Parameters:
| Name | Type | Description |
|---|---|---|
eventHandler | — | The event handler |
opTpes | — | array of the Ops TPEs |
calcLinLength
def calcLinLength(teachHandler, lastTpE, opTpe)Calculates linear tool path length
Parameters:
| Name | Type | Description |
|---|---|---|
teachHandler | — | the teach handler |
lastTpE | — | the last tool path element |
opTpe | — | the current tool path element |
calcCircLength
def calcCircLength(teachHandler, lastTpE, opTpe)Calculates circular tool path length
Parameters:
| Name | Type | Description |
|---|---|---|
teachHandler | — | the teach handler |
lastTpE | — | the last tool path element |
opTpe | — | the current tool path element |
saveReportAs
def saveReportAs(defaultFileName: str, apppath: str)Calls the usual file save dialog
Parameters:
| Name | Type | Description |
|---|---|---|
defaultFileName | str | default file name |
apppath | str | the Application Path for Pictures and Icons |
extendedSaveUI
def extendedSaveUI(Operator, defaultFileName, apppath)extended File Save dialogue with Costs Settings
Parameters:
| Name | Type | Description |
|---|---|---|
Operator | — | the CENPyOlpProgramModifyOperator |
defaultFileName | — | the default Filename of the PDF Report |
apppath | — | the Location of the Caller Script. Needed to find the Images |