YADE Parameter Reference - CompressFiles

Diagram

Elements

CompressFiles
References Schema: CompressFiles, CompressFiles Mapping: compress_files Notes This parameter specifies whether or not the content of the source files should be compressed for the target files using a zip algorithm. In case of sending files each file will be compressed in a single zip file. The extension of the filename is configured with the parameter CompressedFileExtension. A gzip-compatible compression is used, no further software components are required. By default no files will be compressed which corresponds to the value "false". Setting this parameter to the value "true" will cause target files to be compressed. The following parameters are ignored should CompressFiles be used: AppendFiles CheckSize
Element	Type	Required	Description
CompressedFileExtension	string Min: 1 Whitespace: preserve Occurrence: 0..1	Optional	References Schema: CompressedFileExtension Mapping: compressed_file_extension Notes This parameter defines the file extension to be used for the compressed file.

Explanations

Files selected are compressed individually.
Compression takes place at the target.
A gzip-compatible compression is used, no further software components are required.
The CompressedFileExtension parameter specifies the extension of the compressed file.

The AppendFiles parameter is not allowed if this parameter is used.

This parameter defines the file extension for the compressed file. The default value is .gz.