ExportScriptForComputingAmplitudesFromField Struct Reference
Last update: 16.07.2025A struct collecting import information for generating a script that converts field data into random field amplitudes. More...
Public Member Functions | |
| check (Structure 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 More... | |
| ExportScriptForComputingAmplitudesFromField (ReferenceDesign reference_design) | |
| constructor. More... | |
| bool | outputFilesExisting () const |
| save (Structure database) | |
| creates the script file More... | |
Public Attributes | |
| string | database_file |
| The file name of the database that stores the simulation data (relative to path) | |
| string | path |
| Absolute path. | |
| ReferenceDesign | reference_design |
| Stores the information on the reference design/design template (defines which data to be imported) | |
| bool | replace_files |
| If this is true, an existings output file will be overwritten. Otherwise an exception will arise. | |
| string | script_file |
| the file name of the script to be executed for each design directory (relative to path) | |
| string | test_run_path |
| defines the design directory name which is used for test runs (do nothing if empty). Ss relative to More... | |
Detailed Description
A struct collecting import information for generating a script that converts field data into random field amplitudes.
Constructor & Destructor Documentation
◆ ExportScriptForComputingAmplitudesFromField()
| ExportScriptForComputingAmplitudesFromField | ( | ReferenceDesign | reference_design | ) |
constructor.
- Parameters
-
reference_design the reference design being used
Member Function Documentation
◆ check()
| check | ( | Structure | 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
-
database the data base where the data is going to be imported to
◆ outputFilesExisting()
| bool outputFilesExisting | ( | ) | const |
- Returns
- true if at least one of the output files are existing.
◆ save()
| save | ( | Structure | database | ) |
creates the script file
- Parameters
-
database the data base where all data is to be added
Member Data Documentation
◆ 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. Default: "Design0001".
