    

 ## On this page

  

 

 # CreateSimulationArchive Class Reference

 Last update: 16.07.2025 

A struct collecting export information for random field simulation data. [More...](class_create_simulation_archive.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

 [check](class_create_simulation_archive.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) Checks validity of these data. [More...](#a47c34ec1e578c2ce27cf1c5fcd0d1704)  
  [CreateSimulationArchive](class_create_simulation_archive.xhtml#a1694082771d86e6a33750c071ff76a6c) ([ExportReferenceDesign](class_export_reference_design.xhtml) [reference\_design](class_create_simulation_archive.xhtml#acf3a932aa2f8b555c1a254385c014629), string the\_output\_file) constructor. It assumes that the base path is one directory level below the base path of the reference design. It further assumes a default for the design directory names and copies the information on the reference design [More...](#a1694082771d86e6a33750c071ff76a6c)  
  [save](class_create_simulation_archive.xhtml#a6a338dc4344270fcbccadf5667ef12f9) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) exports multiple designs to disk This method tries to export as much data as possible and does even proceed in case of errors. Important: the design directories to be exported to must already exist. [More...](#a6a338dc4344270fcbccadf5667ef12f9)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="a8643191a264f6d55fead82a6d23a88b6"></a>string [output\_file](class_create_simulation_archive.xhtml#a8643191a264f6d55fead82a6d23a88b6) path (absolute path)   
 <a id="acf3a932aa2f8b555c1a254385c014629"></a>[ExportReferenceDesign](class_export_reference_design.xhtml) [reference\_design](class_create_simulation_archive.xhtml#acf3a932aa2f8b555c1a254385c014629) stores the information on the reference design/design directory template (defines which data to be exported)   
 <a id="a2f8b3cba47ad64fb6bda4b6428a032d3"></a>bool [replace\_files](class_create_simulation_archive.xhtml#a2f8b3cba47ad64fb6bda4b6428a032d3) if true, already existing files are to be replaced   
 <a id="details" name="details"></a>## Detailed Description

A struct collecting export information for random field simulation data.

The idea is:

- use the old class [PrepareRandomFieldSimulation](class_prepare_random_field_simulation.xhtml "A struct collecting export information for random field simulation data. ") in a temporary directory
- compress the directory
- save the ZIP file as final target



## Constructor &amp; Destructor Documentation

<a id="a1694082771d86e6a33750c071ff76a6c"></a>## [◆ ](#a1694082771d86e6a33750c071ff76a6c)CreateSimulationArchive()

 [CreateSimulationArchive](class_create_simulation_archive.xhtml)  ( [ExportReferenceDesign](class_export_reference_design.xhtml)  *reference\_design*,    string  *the\_output\_file*   ) 

constructor. It assumes that the base path is one directory level below the base path of the reference design. It further assumes a default for the design directory names and copies the information on the reference design

Parameters reference\_designcontains info on the reference export design the\_output\_filedefines the output file 



## Member Function Documentation

<a id="a47c34ec1e578c2ce27cf1c5fcd0d1704"></a>## [◆ ](#a47c34ec1e578c2ce27cf1c5fcd0d1704)check()

 check  ( [Structure](class_structure.xhtml)  *database*) 

Checks validity of these data.

If any of the specified directories or files does not exist, an exception is thrown It also checks the validity of the reference design It further checks if any of the objects to be exported does not exist. And if the scalar data contain valid amplitudes

Parameters databasethe data base where the data is stored 



<a id="a6a338dc4344270fcbccadf5667ef12f9"></a>## [◆ ](#a6a338dc4344270fcbccadf5667ef12f9)save()

 save  ( [Structure](class_structure.xhtml)  *database*) 

exports multiple designs to disk This method tries to export as much data as possible and does even proceed in case of errors. Important: the design directories to be exported to must already exist.

Parameters databasethe data base where all data is contained.