OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator Class Reference

calculate a report More...

Public Member Functions

 TRptDataCalculator (String APathStandardReports, String APathCustomReports)
 constructor More...
 
Boolean GenerateResult (ref TParameterList parameterlist, ref string strHTMLOutput, out HtmlDocument HTMLDocument, ref String AErrorMessage, ref Exception AException, TDBTransaction ATransaction)
 this is where all the calculations take place More...
 

Protected Member Functions

Boolean CalculateFromClass (string ANamespaceClass, TDBTransaction ATransaction)
 call a class that calculates the result for a report or extract More...
 
string LoadReportDefinitionFile (String htmlfile)
 load the HTML file that defines the report More...
 

Protected Attributes

String FPathStandardReports
 where to search for the standard reports (xml files) More...
 
String FPathCustomReports
 where to search for the custom reports (xml files) More...
 
string FHTMLTemplate
 the HTML template More...
 
HtmlDocument FHtmlDocument
 the HTML Output More...
 
TParameterList FParameters
 the Parameters More...
 

Detailed Description

calculate a report

Constructor & Destructor Documentation

◆ TRptDataCalculator()

Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.TRptDataCalculator ( String  APathStandardReports,
String  APathCustomReports 
)
inline

constructor

Member Function Documentation

◆ CalculateFromClass()

Boolean Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.CalculateFromClass ( string  ANamespaceClass,
TDBTransaction  ATransaction 
)
inlineprotected

call a class that calculates the result for a report or extract

◆ GenerateResult()

Boolean Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.GenerateResult ( ref TParameterList  parameterlist,
ref string  strHTMLOutput,
out HtmlDocument  HTMLDocument,
ref String  AErrorMessage,
ref Exception  AException,
TDBTransaction  ATransaction 
)
inline

this is where all the calculations take place

Returns
true if the report was successfully generated

◆ LoadReportDefinitionFile()

string Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.LoadReportDefinitionFile ( String  htmlfile)
inlineprotected

load the HTML file that defines the report

Parameters
htmlfilea file name

Member Data Documentation

◆ FHtmlDocument

HtmlDocument Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.FHtmlDocument
protected

the HTML Output

◆ FHTMLTemplate

string Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.FHTMLTemplate
protected

the HTML template

◆ FParameters

TParameterList Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.FParameters
protected

the Parameters

◆ FPathCustomReports

String Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.FPathCustomReports
protected

where to search for the custom reports (xml files)

◆ FPathStandardReports

String Ict.Petra.Server.MReporting.Calculator.TRptDataCalculator.FPathStandardReports
protected

where to search for the standard reports (xml files)


The documentation for this class was generated from the following file: