Adams Basic Package > Adams View > View Command Language > file > file html write

file html write

Allows you to export the Adams PostProcessor data in the current session of Adams PostProcessor as an HTML report for viewing by others in your organization.

Format:

 
file html write
file_name =
file
output_directory =
string
title =
string
author =
string
date =
date
comment =
string
model_name =
existing model
page_name =
existing page
title_image_file_name =
file
image_width =
integer
image_height =
integer
image_format =
png/jpg
movie_format =
png/ jpg/ avi/mpg
export_animations =
boolean
avi_frames_per_second =
integer
avi_quality =
integer
avi_keyframe_every =
integer
mpeg_ngop =
integer
mpeg_round_size =
boolean
include_points =
boolean
include_markers =
boolean

Example:

 
File Html Write &
File=(.gui.ppt_file_export.c_html.c_tabs.c_file.file_var.string_value) &
Output_directory =(.gui.ppt_file_export.c_html.c_tabs.c_file.dir_var) &
Page_name =Page_1 &
Title=(.gui.ppt_file_export.c_html.c_tabs.c_title.title_var) &
Model_name=.model_1 &
Comment="This Report Is For Analysis_1 In Model Model_1" &
Date=(.gui.ppt_file_export.c_html.c_tabs.c_title.date_var) &
Author=(.gui.ppt_file_export.c_html.c_tabs.c_title.author_var) &
Title_image_file_name=(.gui.ppt_file_export.c_html.c_tabs.c_title.image_var) &
Image_format =Png &
Image_height =423 &
Image_width =834 &
Export_animations =Yes &
Movie_format =Avi &
Avi_compression=(Eval(.gui.ppt_file_export.c_html.c_tabs.c_pages.o_movie_format.current_choice) == "Compressed Avi" ? "Yes" : "No") &
Avi_keyframe_every = 500 &
Avi_frames_per_sec = 10 &
Avi_quality = 75
Include_markers = Yes

Description:

 
Parameter
Value Type
Description
file_name
File name
Specifies the name of the top-level file that is to be written.
output_directory
String
Specifies where you want the resulting HTML files and folders to be stored. This directory may not exist yet.
title
String
Specifies a title for the published data. It will be used as the title in the top HTML file, and appear on the title page.
author
String
Specifies the author of the data. It will appear on the title page.
date
Date
Specifies the date the data was published. It will appear on the title page.
comment
String
Specifies any comments about the data. It will appear on the title page.
model_names
Existing model
Specifies the models for which you want to export information.
page_name
Existing page
Specifies the pages of plots and animations you want exported.
title_image_file_name
File
Specifies the path and file of an image to appear in the upper right corner.
image_width
Integer
Enter the pixel size width of the exported pages.
image_height
Integer
Enter the pixel size height of the exported pages.
image_format
Png/jpg
For the pages of plots, enter the image format in which to store the pages of plots.
movie_format
Png/ jpg/ avi/mpg.
Specifies the type of movie to export the animation as. (AVI format is only available on Windows.)
export_animations
Yes/No
Values are:
yes - Export any page with animations as movies.
no - For all pages, export each as a single image file.
avi_frames_per_second
Integer
If you select compressed AVI format, set the frame rate. The default is a frame rate of 10 seconds per frame.
avi_compression
Yes/no
Specifies whether or not to compress an AVI file. Values are: yes and no. The default is yes.
avi_quality
Integer
Specifies quality as a percent_integer from 1 to 100. Larger the number, better the quality and larger the AVI file. The default is 75% compression.
avi_keyframe_every
Integer
Indicates how often a complete frame (keyframe) is written to the AVI file; the smaller the number, the larger the file. The default is each key frame 500 frames apart.
mpeg_ngop
Integer
Indicates how often a complete frame (keyframe) is written to the MPEG file
mpeg_round_size
Yes/no
Some playback programs require the pixel height and width to be multiplies of 16. Set this option to yes to ensure that your movie plays in many playback programs.
Include_points
Yes/No
Specifies whether Points information needs to be included in the HTML report
Include_markers
Yes/No
Specifies whether Marker information needs to be included in the HTML report

Extended Definition:

1. For the file_name parameter,the proper extension is the default .htm, but you can override it by supplying a different extension. There will be several other files and subdirectoreis exported in the report.
It is not necessary to enclose the file name in quotes if it only contains alphanumeric characters and starts with a letter. If you want to include other characters, such as a '.' for an extension or '/' or '[]' for directory paths, you must enclose the file name in quotes.
2. When you export model information, you output information about the model objects: parts, constraints, forces, measures, requests, and assembly objects. Adams View creates a folder for each model and objects in the model, grouped by type.
3. By default, Adams PostProcessor maintains the aspect ratio of the images so if you enter a value for image_width, Adams PostProcessor automatically calculates the height based on the current aspect ratio, and the reverse.
If you leave image_width and image_height blank, Adams View uses their default size in Adams PostProcessor.
4. For the movie_format parameter,
■If you select jpg or png, Adams Processor, exports each frame as an png or jpg file, and then plays them as a movie.
■If you select compressed AVI format, set avi_frames_per_second.
■If you select .mpg, you can also set mpeg_ngop or mpeg_round_size.
5. For the “mpeg_ngop” parameter, the smaller the number, the larger the file. Some movie players cannot handle compression; in that case, set to 1.