OrsReportGenerator_5c105186d0aa11e99900309c235e8fdb

Generates reports

author:

Dragonfly Team

contact:

https://dragonfly.comet.tech

email:

support.dragonfly@comet.tech

organization:

Comet Technologies Canada Inc.

address:

460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7

copyright:

Comet Technologies Canada Inc. All rights reserved 2023.

date:

Sep 06 2019 09:29

dragonflyVersion:

4.5.0.711 (D)

UUID:

5c105186d0aa11e99900309c235e8fdb

Class Code

class OrsPythonPlugins.OrsReportGenerator_5c105186d0aa11e99900309c235e8fdb.OrsReportGenerator_5c105186d0aa11e99900309c235e8fdb.OrsReportGenerator_5c105186d0aa11e99900309c235e8fdb(*args, **kwargs)
addInputXMLFilenamesFromFolder(inputXMLFolderName, includeSubfolders=True)

Adds the XML files found in the provided folder to those that should be analyzed.

Parameters:

  • inputXMLFolderName (folder) – provided folder

  • includeSubfolders (bool) – if True, the subfolders are also searched for XML files

exportCurrentInputFilesAsMergedXML(outputFilename)

Generates a XML document from the XML input data with the same format as the one that would be sent to an XSL transformation. This may be used when developing an XSL file.

Parameters:

outputFilename (file saving) – merged XML filename

interfacemethod generateReport(inputDataFilenames: List[str] = None, xsltUUID: str = '', outputFilename: str = '', saveTEXFile: bool = False, showMessageBoxIfSuccessful: bool = True, showMessageBoxIfFailed: bool = True, inputDataFilename: str = None) → None

Generates a report based on some data.

Changed in version -: Argument inputDataFilename (single instance) is replaced by inputDataFilenames (list)

Parameters:

  • inputDataFilenames (file) [count=[1, None]] – input data filenames

  • xsltUUID (str) – unique identifier (UUID) of the XSLT stylesheet

  • outputFilename (file saving) – report filename

  • saveTEXFile (bool) – if True, the .tex file will be saved in the output folder

  • showMessageBoxIfSuccessful (bool) – if True, the message box informing about a successful generation will be displayed. Otherwise, no message box will appear.

  • showMessageBoxIfFailed (bool) – if True, the message box informing about an error during the generation will be displayed. Otherwise, no message box will appear.

  • inputDataFilename (file) [deprecated: use inputDataFilenames instead] – input data filename

Anonymize inputDataFilenames:

True

Anonymize inputDataFilename:

True

classmethod getMainFormClass()

Gets the class of the main form

Returns:

output –

updateXSLTUUIDFromAvailableXSLTUUIDs()

Selects an XSLT UUID from the list of the available possibilities. If the current UUID is found in the list, it is kept. If the current UUID is not found in the list, the first one is selected.