## On this page

  

 

 # ExportScriptForComputingAmplitudesFromField Struct Reference

 Last update: 16.07.2025 

A struct collecting import information for generating a script that converts field data into random field amplitudes. [More...](struct_export_script_for_computing_amplitudes_from_field.xhtml#details)

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

 [check](struct_export_script_for_computing_amplitudes_from_field.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) 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 [More...](#a47c34ec1e578c2ce27cf1c5fcd0d1704)  
  [ExportScriptForComputingAmplitudesFromField](struct_export_script_for_computing_amplitudes_from_field.xhtml#a186791859f9548629fa15085135e77f0) ([ReferenceDesign](class_reference_design.xhtml) [reference\_design](struct_export_script_for_computing_amplitudes_from_field.xhtml#ab0f4ff8e7cbf191376f5487872de03f7)) constructor. [More...](#a186791859f9548629fa15085135e77f0)  
 bool [outputFilesExisting](struct_export_script_for_computing_amplitudes_from_field.xhtml#a5000ee7f35b6c3e27e53abb74606bcd9) () const  [save](struct_export_script_for_computing_amplitudes_from_field.xhtml#a6a338dc4344270fcbccadf5667ef12f9) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) creates the script file [More...](#a6a338dc4344270fcbccadf5667ef12f9)  
 ## <a name="pub-attribs"></a>Public Attributes

<a id="a90c11fb8a955197d99f5dfc621bd2856"></a>string [database\_file](struct_export_script_for_computing_amplitudes_from_field.xhtml#a90c11fb8a955197d99f5dfc621bd2856) The file name of the database that stores the simulation data (relative to [path](struct_export_script_for_computing_amplitudes_from_field.xhtml#a46c20eb2a26abeb1e934cd66e1dd6484 "Absolute path. "))   
 <a id="a46c20eb2a26abeb1e934cd66e1dd6484"></a>string [path](struct_export_script_for_computing_amplitudes_from_field.xhtml#a46c20eb2a26abeb1e934cd66e1dd6484) Absolute path.   
 <a id="ab0f4ff8e7cbf191376f5487872de03f7"></a>[ReferenceDesign](class_reference_design.xhtml) [reference\_design](struct_export_script_for_computing_amplitudes_from_field.xhtml#ab0f4ff8e7cbf191376f5487872de03f7) Stores the information on the reference design/design template (defines which data to be imported)   
 <a id="a2f8b3cba47ad64fb6bda4b6428a032d3"></a>bool [replace\_files](struct_export_script_for_computing_amplitudes_from_field.xhtml#a2f8b3cba47ad64fb6bda4b6428a032d3) If this is true, an existings output file will be overwritten. Otherwise an exception will arise.   
 <a id="a586bce376efc55f8678878ee594446f4"></a>string [script\_file](struct_export_script_for_computing_amplitudes_from_field.xhtml#a586bce376efc55f8678878ee594446f4) the file name of the script to be executed for each design directory (relative to [path](struct_export_script_for_computing_amplitudes_from_field.xhtml#a46c20eb2a26abeb1e934cd66e1dd6484 "Absolute path. "))   
 string [test\_run\_path](struct_export_script_for_computing_amplitudes_from_field.xhtml#af033bf10e916683e009f2cdd9e2c5810) defines the design directory name which is used for test runs (do nothing if empty). Ss relative to [More...](#af033bf10e916683e009f2cdd9e2c5810)  
 <a id="details" name="details"></a>## Detailed Description

A struct collecting import information for generating a script that converts field data into random field amplitudes.



## Constructor &amp; Destructor Documentation

<a id="a186791859f9548629fa15085135e77f0"></a>## [◆ ](#a186791859f9548629fa15085135e77f0)ExportScriptForComputingAmplitudesFromField()

 [ExportScriptForComputingAmplitudesFromField](struct_export_script_for_computing_amplitudes_from_field.xhtml)  ( [ReferenceDesign](class_reference_design.xhtml)  *reference\_design*) 

constructor.

Parameters reference\_designthe reference design being used 



## 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

Parameters databasethe data base where the data is going to be imported to 



<a id="a5000ee7f35b6c3e27e53abb74606bcd9"></a>## [◆ ](#a5000ee7f35b6c3e27e53abb74606bcd9)outputFilesExisting()

 bool outputFilesExisting  ( )  const

Returnstrue if at least one of the output files are existing. 



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

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

creates the script file

Parameters databasethe data base where all data is to be added 



## Member Data Documentation

<a id="af033bf10e916683e009f2cdd9e2c5810"></a>## [◆ ](#af033bf10e916683e009f2cdd9e2c5810)test\_run\_path

 string test\_run\_path

defines the design directory name which is used for test runs (do nothing if empty). Ss relative to

See also[path](struct_export_script_for_computing_amplitudes_from_field.xhtml#a46c20eb2a26abeb1e934cd66e1dd6484 "Absolute path. "). Default: "Design0001".