A web-ready report of the analysis results may be generated using the [Report] button on the View tab:
Scan&Solve will prompt for a destination, generate the report, and open your web browser to view the output.
Scan&Solve uses template files to construct the web-ready reports when the [Report] button is clicked in the View tab. These template files, located in the installation directory, are read by Scan&Solve and the output files are generated based on the contents of the templates. The templates use a simple format that may be easily modified to suit a particular end user application. The only tool required is Microsoft’s Notepad or a similar text editor.
One of two different templates is used depending on the current view setting. Advanced view uses AdvancedReportTemplate.html, the simplified view uses SimplifiedReportTemplate.html. The content of these files looks something like the following (Color and Descriptions added):
The Report Section, where modifications may be made, contains a mixture of HTML code and Scan&Solve keywords.
The standard HTML code is demarcated by
<format_code>text</format_code>
where the format_code controls how the text between the demarcations will be formatted in the output report. HTML code is ignored by Scan&Solve and passed to the output unchanged. Thus, the HTML formatting and content can be changed to suit a particular application, including additional text or images. More information on HTML formatting may be found on the web.
The Scan&Solve output is generated by the lines containing a ##KEYWORD followed, in most cases, by a series of parameters. The keywords, their parameters, and their results in the output are as follows:
Keyword | Parameters |
---|---|
##SCREENSHOT | With no trailing parameters includes in the report an image from the active Rhino viewport |
BCS includes an image of the geometry plus the applied boundary conditions | |
SOLUTION includes an image of analysis results | |
The solution quantity to be displayed is specified by a trailing valid component tag (see below) | |
##PROPERTYTABLE | GEOMETRY includes a table of basic information about the geometry |
MATERIAL includes a table of the properties of the material currently in use | |
LOADS includes a summary table of the applied loads | |
RESTRAINTS includes a summary table of the applied restraints | |
ANALYSISSETTINGS includes a table of the current analysis settings | |
EXTREMA includes the maximum and minimum values of the analysis results as specified by a valid component tag (see below) | |
##EXTREMATABLE | Includes the maximum and minimum values of the analysis results as specified by a sequence of valid component tags (see below) |
##DATETIME | DATE includes the current date in the report, may be followed by TIME |
TIME includes the current time in the report, may be followed by DATE |
The reporting system in Scan&Solve recognizes the following component tags, mapping them to solution quantities for inclusion in the report.
Before editing a report template, make a backup copy in case of errors or problems. Edit the desired template as follows:
These two examples depict the output arising from sequences of template code. Refer to the previous section for more details on the specific keywords and their parameters.
Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example introduces the use of the ##SCREENSHOT keyword and the generation of a table using the ##PROPERTYTABLE keyword.
Template code on the left gives rise to the output on the right. HTML code is output directly to the report file unchanged. Scan&Solve code is interpreted by the Scan&Solve plugin to produce the output shown on the right. This example shows an expanded use of the ##SCREENSHOT keyword to display a solution value. The ##PROPERTYTABLE keyword is used to generate a summary of a solution component using the EXTREMA parameter and a solution component tag, TDSP, for total displacement.