## On this page
# ExportReferenceDesign Class Reference
Last update: 16.07.2025
defines information on imported data and files given a reference design This class contains settings for an example design directory (the base\_path). These settings include file formats, data items to be imported etc. [More...](class_export_reference_design.xhtml#details)
## Public Types
typedef std::vector< [ExportItemInfo](struct_export_item_info.xhtml) > [ExportItemInfoVector](class_export_reference_design.xhtml#aad0222392d9427fe94936b201df420f5) a set of data items
## Public Member Functions
[addFile\_Abaqus](class_export_reference_design.xhtml#afd5c422a5396fc7f6fc9d67639056f22) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in Abaqus format. [More...](#afd5c422a5396fc7f6fc9d67639056f22)
[addFile\_ANSYS\_MechanicalDat](class_export_reference_design.xhtml#a11351628e3f4ed33a44e62f7647d4cdf) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in ANSYS format. [More...](#a11351628e3f4ed33a44e62f7647d4cdf)
[addFile\_CSV](class_export_reference_design.xhtml#a25975bef494f5516da7d134fd896fcdc) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a25975bef494f5516da7d134fd896fcdc)
[addFile\_ElementDataCSV](class_export_reference_design.xhtml#a69cfbc9c84840bb99ee4c2406e8982ca) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a69cfbc9c84840bb99ee4c2406e8982ca)
[addFile\_ExternalDataCSV\_Disp](class_export_reference_design.xhtml#ac43d8e7376c34c5ba30b896c528faf2b) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#ac43d8e7376c34c5ba30b896c528faf2b)
[addFile\_ExternalDataCSV\_ElementData](class_export_reference_design.xhtml#aa943a7bdfa46cb4dc1dd8556c1c4a91d) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#aa943a7bdfa46cb4dc1dd8556c1c4a91d)
[addFile\_ExternalDataCSV\_NodeData](class_export_reference_design.xhtml#a6efea91fe71c8a65f3e2e8c1f70d2a75) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#a6efea91fe71c8a65f3e2e8c1f70d2a75)
[addFile\_Image](class_export_reference_design.xhtml#a1275367105e2c8901916e138e7cfca39) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to an image file. [More...](#a1275367105e2c8901916e138e7cfca39)
[addFile\_LSDynaK](class_export_reference_design.xhtml#a76135b512886e51aab814744632e64a8) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in LS-DYNA K format. [More...](#a76135b512886e51aab814744632e64a8)
[addFile\_Nastran](class_export_reference_design.xhtml#a8ddc7416b07c7f2d1499680759384173) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in Nastran format. [More...](#a8ddc7416b07c7f2d1499680759384173)
[addFile\_NodeDataCSV](class_export_reference_design.xhtml#a897d79d7afae207e2a37efe46cf6e099) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a897d79d7afae207e2a37efe46cf6e099)
[addFile\_PERMAS](class_export_reference_design.xhtml#ab673c9293b5fc4fc3c8c2cbd5e663adb) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in PERMAS format. [More...](#ab673c9293b5fc4fc3c8c2cbd5e663adb)
[addFile\_SingleSignalCSV](class_export_reference_design.xhtml#ae0dfe689645de46b022fae82426a4367) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#ae0dfe689645de46b022fae82426a4367)
[addFile\_STL](class_export_reference_design.xhtml#ad5c4c8b3993209b6356f59233da1da48) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in binary STL format. [More...](#ad5c4c8b3993209b6356f59233da1da48)
[addNewFile\_ANSYS\_MechanicalDat](class_export_reference_design.xhtml#a04a1fdd72ada5fdc452514a9c4bf50c4) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in ANSYS format. [More...](#a04a1fdd72ada5fdc452514a9c4bf50c4)
[addNewFile\_CSV](class_export_reference_design.xhtml#a83918abf42f3da6e1f661d0c934db8e6) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a83918abf42f3da6e1f661d0c934db8e6)
[addNewFile\_ElementDataCSV](class_export_reference_design.xhtml#a3e64cb5601dd92fdcb5f6c7b4aa47821) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a3e64cb5601dd92fdcb5f6c7b4aa47821)
[addNewFile\_ExternalDataCSV\_Disp](class_export_reference_design.xhtml#a2ee22474f946ef03aaf09c6cd8bc2027) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#a2ee22474f946ef03aaf09c6cd8bc2027)
[addNewFile\_ExternalDataCSV\_ElementData](class_export_reference_design.xhtml#a76b991ea6ce71214e9cb6405c9abb549) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#a76b991ea6ce71214e9cb6405c9abb549)
[addNewFile\_ExternalDataCSV\_NodeData](class_export_reference_design.xhtml#ae7616f698ea9bc6e01cc3b7aa80a13f0) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in External data CSV format. [More...](#ae7616f698ea9bc6e01cc3b7aa80a13f0)
[addNewFile\_Image](class_export_reference_design.xhtml#afefd9c2283ba25c163db5a3e425cdada) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to an image file. [More...](#afefd9c2283ba25c163db5a3e425cdada)
[addNewFile\_NodeDataCSV](class_export_reference_design.xhtml#a5a5650a453ef5dc6234b03637f34fb81) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a5a5650a453ef5dc6234b03637f34fb81)
[addNewFile\_SingleSignalCSV](class_export_reference_design.xhtml#a465219c4c28557c300af22483ee56af2) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in CSV format. [More...](#a465219c4c28557c300af22483ee56af2)
[addNewFile\_STL](class_export_reference_design.xhtml#a62e8f818707d85c2631acbdc8058180e) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Exports information to a file in binary STL format. [More...](#a62e8f818707d85c2631acbdc8058180e)
[check](class_export_reference_design.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) checks if the settings are valid and produces an error. [More...](#a47c34ec1e578c2ce27cf1c5fcd0d1704)
[checkFiles](class_export_reference_design.xhtml#a42cfe17a0305737404dfbc962360d076) (string abs\_design\_dir\_path, bool quiet=false) checks if all required files to be exported to exist in the given design directory [More...](#a42cfe17a0305737404dfbc962360d076)
[checkObjects](class_export_reference_design.xhtml#ade36e04546c5bec4f28ca492d21875f9) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), int sample, bool quiet=false) checks if all required objects for the given design number are existing in the database [More...](#ade36e04546c5bec4f28ca492d21875f9)
[ExportReferenceDesign](class_export_reference_design.xhtml#a7aee363b2bbb561ef1d20b2aaaaf61d9) (string the\_base\_path) constructor [More...](#a7aee363b2bbb561ef1d20b2aaaaf61d9)
string [generateScriptOfSettingsDefinition](class_export_reference_design.xhtml#a80b1eab921bf9c19f1b13b17b5af357b) (string variable\_ident, string other\_base\_path="") generates a script string (Lua) that is used to build up the current settings object. [More...](#a80b1eab921bf9c19f1b13b17b5af357b)
std::vector< string > [getFiles](class_export_reference_design.xhtml#a41ace7f379338ca7d3779b204c3776b7) () assembles the complete list of files being known to this class This is a compact view onto the contained data, since multiple items may be imported from a single file. [More...](#a41ace7f379338ca7d3779b204c3776b7)
std::vector< string > [getFilesToExport](class_export_reference_design.xhtml#a50f67f9f53f6797a9a1c9439d849fbc5) () assembles a list of files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive. [More...](#a50f67f9f53f6797a9a1c9439d849fbc5)
[ExportItemInfo](struct_export_item_info.xhtml) [getItem](class_export_reference_design.xhtml#a4881b245e33d0ed0edc04e74b94df300) (string filename, [ExportItemInfo::Type](struct_export_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) data\_type) gets the respective item if existing [More...](#a4881b245e33d0ed0edc04e74b94df300)
number [getItemIndex](class_export_reference_design.xhtml#a775316552fabc83e39b74beddef81334) (string filename, [ExportItemInfo::Type](struct_export_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) data\_type) gets the index of the respective item if existing [More...](#a775316552fabc83e39b74beddef81334)
std::vector< number > [getItemsForFile](class_export_reference_design.xhtml#adb9208885a8e74195f267a2df949dca9) (string filename) assembles a list of items which are to be exported to a specific file [More...](#adb9208885a8e74195f267a2df949dca9)
std::vector< string > [getModifiedFiles](class_export_reference_design.xhtml#a2522c988ad2eaf346ae7af8cd47ff11b) () assembles the complete list of files being known to this class and that are NOT to be created This is a compact view onto the contained data, since multiple items may be imported from a single file. [More...](#a2522c988ad2eaf346ae7af8cd47ff11b)
std::vector< string > [getModifiedFilesToExport](class_export_reference_design.xhtml#af01172accc310310cc51e31caf936730) () assembles a list of modified files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive. The filenames in this list contain only those files that are not "newly created" but modified. [More...](#af01172accc310310cc51e31caf936730)
std::vector< string > [getNewFilesToExport](class_export_reference_design.xhtml#a1488cf7e390e0191e91de8e87206b87f) () assembles a list of new files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive. The filenames in this list contain only those files that are not "newly created" but modified. [More...](#a1488cf7e390e0191e91de8e87206b87f)
[modifyDesign](class_export_reference_design.xhtml#a19fe83020c2cdfe68f4215af8cdf48cb) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), int sample\_number, string design\_path="", bool do\_not\_check\_settings=false) modifies a design on disk [More...](#a19fe83020c2cdfe68f4215af8cdf48cb)
[removeFileFromList](class_export_reference_design.xhtml#adc5b63f5d31ab0a4abf354b4934514f7) (string filename) removes all import data from item list which is associated with the sepcified file [More...](#adc5b63f5d31ab0a4abf354b4934514f7)
[setBasePath](class_export_reference_design.xhtml#aa2ba2b1794ac9bad08da653ea8c99eda) (string path) sets a new base path. This includes changing the relative path definition of the already parsed files. [More...](#aa2ba2b1794ac9bad08da653ea8c99eda)
[setExportDesign](class_export_reference_design.xhtml#ad838ca5bc438676ab92db57b56ae56c0) (number item, string design\_ident="") sets if the quantity ident of an item [More...](#ad838ca5bc438676ab92db57b56ae56c0)
[setExportQuantity](class_export_reference_design.xhtml#a4a053c513b14789817eca6aa636a5813) (number item, string quantity\_ident="") sets if the quantity ident of an item [More...](#a4a053c513b14789817eca6aa636a5813)
[setExportSource](class_export_reference_design.xhtml#ad1067f1ab8cf433485b3a049f13d1559) (number item, [ExportItemInfo::DataSource](struct_export_item_info.xhtml#ac409d3942abd5b826fb1508efc119564) source) sets if the source of an item [More...](#ad1067f1ab8cf433485b3a049f13d1559)
## Public Attributes
::ansys::ANSYS\_Mechanical\_DSDAT\_Settings [ANSYS\_DSDAT\_settings](class_export_reference_design.xhtml#abbf761e829467ff8c85745c8d6af3659) contains settings for the ANSYS DS.DAT modifier
string [base\_path](class_export_reference_design.xhtml#a1be53c8e392d898f99ddc804ff403c84) defines the base path is stored as absolute path do never change it directly! Please use [setBasePath()](class_export_reference_design.xhtml#aa2ba2b1794ac9bad08da653ea8c99eda "sets a new base path. This includes changing the relative path definition of the already parsed files...") instead!
bool [fmop\_use\_sampling\_bounds](class_export_reference_design.xhtml#ac8d8dae79bb9c8bfd736f429be701289) if true, the point to be approximated by FMOP, must be within the original sampling bounds.
[ExportItemInfoVector](class_export_reference_design.xhtml#aad0222392d9427fe94936b201df420f5) [items](class_export_reference_design.xhtml#a630002260461fbcd78cb76ea209ac36a) stores all parsed data item information
bool [mesh\_smoothening](class_export_reference_design.xhtml#ac64fc8a28d48239a5b846d8ebf021484) defines if the deviation is applied with smoothening if true: use iterative smoothening, if false: use no smoothening. Default: false. mesh smoothening works with distance fields and without.
bool [throw\_error\_on\_unstable\_mesh](class_export_reference_design.xhtml#ac92d2c3e8ade2a17ee2edb8eb6747008) defines if an error is thrown in the case then mesh smoothening was not successful.
bool [use\_distancefield](class_export_reference_design.xhtml#a3cd324c8d4c3009af0376b08a2a348e3) defines the method for applying geometric variations if false: Use a normal vector on the boundary. if true: Use an iterative distance field strategy
## Detailed Description
defines information on imported data and files given a reference design This class contains settings for an example design directory (the base\_path). These settings include file formats, data items to be imported etc.
NoteThe currently stored data must be kept "functional" at all times. If you add a new file using the appropriate function, this will take care for you. If you change the data items from outside (GUI etc.) you must use the function [check()](class_export_reference_design.xhtml#a47c34ec1e578c2ce27cf1c5fcd0d1704 "checks if the settings are valid and produces an error. ") in order to approve the changes. If the changes are erroneous, the next addFIle-method call may lead to undefined behaviour.
## Constructor & Destructor Documentation
## [◆ ](#a7aee363b2bbb561ef1d20b2aaaaf61d9)ExportReferenceDesign()
[ExportReferenceDesign](class_export_reference_design.xhtml) ( string *the\_base\_path*)
constructor
Parameters the\_base\_pathdefines the base path
## Member Function Documentation
## [◆ ](#afd5c422a5396fc7f6fc9d67639056f22)addFile\_Abaqus()
addFile\_Abaqus ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in Abaqus format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a11351628e3f4ed33a44e62f7647d4cdf)addFile\_ANSYS\_MechanicalDat()
addFile\_ANSYS\_MechanicalDat ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in ANSYS format.
**[Deprecated:](deprecated.xhtml#_deprecated000004)**Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a25975bef494f5516da7d134fd896fcdc)addFile\_CSV()
addFile\_CSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000007)**A CSV file will always be rewritten. It further contains all available scalar quantities.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a69cfbc9c84840bb99ee4c2406e8982ca)addFile\_ElementDataCSV()
addFile\_ElementDataCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000008)**A CSV file will always be rewritten. It further contains the selected element quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#ac43d8e7376c34c5ba30b896c528faf2b)addFile\_ExternalDataCSV\_Disp()
addFile\_ExternalDataCSV\_Disp ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000013)**A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#aa943a7bdfa46cb4dc1dd8556c1c4a91d)addFile\_ExternalDataCSV\_ElementData()
addFile\_ExternalDataCSV\_ElementData ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000012)**A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a6efea91fe71c8a65f3e2e8c1f70d2a75)addFile\_ExternalDataCSV\_NodeData()
addFile\_ExternalDataCSV\_NodeData ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000011)**A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a1275367105e2c8901916e138e7cfca39)addFile\_Image()
addFile\_Image ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to an image file.
**[Deprecated:](deprecated.xhtml#_deprecated000006)**Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a76135b512886e51aab814744632e64a8)addFile\_LSDynaK()
addFile\_LSDynaK ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in LS-DYNA K format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be modified. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a8ddc7416b07c7f2d1499680759384173)addFile\_Nastran()
addFile\_Nastran ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in Nastran format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a897d79d7afae207e2a37efe46cf6e099)addFile\_NodeDataCSV()
addFile\_NodeDataCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000009)**A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#ab673c9293b5fc4fc3c8c2cbd5e663adb)addFile\_PERMAS()
addFile\_PERMAS ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in PERMAS format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#ae0dfe689645de46b022fae82426a4367)addFile\_SingleSignalCSV()
addFile\_SingleSignalCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
**[Deprecated:](deprecated.xhtml#_deprecated000010)**A CSV file will always be rewritten. It further contains the selected node quantity. The first column will not denote the node ID, but the respective x-coordinate
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#ad5c4c8b3993209b6356f59233da1da48)addFile\_STL()
addFile\_STL ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in binary STL format.
**[Deprecated:](deprecated.xhtml#_deprecated000005)**Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a04a1fdd72ada5fdc452514a9c4bf50c4)addNewFile\_ANSYS\_MechanicalDat()
addNewFile\_ANSYS\_MechanicalDat ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in ANSYS format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a83918abf42f3da6e1f661d0c934db8e6)addNewFile\_CSV()
addNewFile\_CSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
A CSV file will always be rewritten. It further contains all available scalar quantities.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a3e64cb5601dd92fdcb5f6c7b4aa47821)addNewFile\_ElementDataCSV()
addNewFile\_ElementDataCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
A CSV file will always be rewritten. It further contains the selected element quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a2ee22474f946ef03aaf09c6cd8bc2027)addNewFile\_ExternalDataCSV\_Disp()
addNewFile\_ExternalDataCSV\_Disp ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a76b991ea6ce71214e9cb6405c9abb549)addNewFile\_ExternalDataCSV\_ElementData()
addNewFile\_ExternalDataCSV\_ElementData ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#ae7616f698ea9bc6e01cc3b7aa80a13f0)addNewFile\_ExternalDataCSV\_NodeData()
addNewFile\_ExternalDataCSV\_NodeData ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in External data CSV format.
A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#afefd9c2283ba25c163db5a3e425cdada)addNewFile\_Image()
addNewFile\_Image ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to an image file.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a5a5650a453ef5dc6234b03637f34fb81)addNewFile\_NodeDataCSV()
addNewFile\_NodeDataCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
A CSV file will always be rewritten. It further contains the selected node quantity.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a465219c4c28557c300af22483ee56af2)addNewFile\_SingleSignalCSV()
addNewFile\_SingleSignalCSV ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in CSV format.
A CSV file will always be rewritten. It further contains the selected node quantity. The first column will not denote the node ID, but the respective x-coordinate
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be WRITTEN. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a62e8f818707d85c2631acbdc8058180e)addNewFile\_STL()
addNewFile\_STL ( [Structure](class_structure.xhtml) *database*, string *filename* )
Exports information to a file in binary STL format.
Multiple data items per file are supported.
Parameters databaseThe current database where the items are to be extracted from filenameThe file to be MODIFIED. The file path will be treated as relative to the base\_path or if this is not existing, take it as absolute path respective relative to the working directory
## [◆ ](#a47c34ec1e578c2ce27cf1c5fcd0d1704)check()
check ( [Structure](class_structure.xhtml) *database*)
checks if the settings are valid and produces an error.
Parameters databasethe data base Exceptions exceptionif an error was detected
## [◆ ](#a42cfe17a0305737404dfbc962360d076)checkFiles()
checkFiles ( string *abs\_design\_dir\_path*, bool *quiet* = `false` )
checks if all required files to be exported to exist in the given design directory
Parameters abs\_design\_dir\_paththe path of the design directory to be checked quietif true, then no log message is printed Exceptions exceptionif at least one required object is missing for exporting the design for the given sample number.
## [◆ ](#ade36e04546c5bec4f28ca492d21875f9)checkObjects()
checkObjects ( [Structure](class_structure.xhtml) *database*, int *sample*, bool *quiet* = `false` )
checks if all required objects for the given design number are existing in the database
Parameters databasethe data base samplethe sample number used to generate the sample design idents quietif true, then no log message is printed Exceptions exceptionif at least one required object is missing for exporting the design for the given sample number.
## [◆ ](#a80b1eab921bf9c19f1b13b17b5af357b)generateScriptOfSettingsDefinition()
string generateScriptOfSettingsDefinition ( string *variable\_ident*, string *other\_base\_path* = `""` )
generates a script string (Lua) that is used to build up the current settings object.
Returnsthe script code, ends with newline. Parameters variable\_identthe ident of the Lua variable that contains the settings object other\_base\_pathif this string is empty, then this string is used as the base path of the exported definition. This must be a Lua variable, so either a Lua variable name or a string containing the path
## [◆ ](#a41ace7f379338ca7d3779b204c3776b7)getFiles()
std::vector<string> getFiles ( )
assembles the complete list of files being known to this class This is a compact view onto the contained data, since multiple items may be imported from a single file.
Returnsa list of filenames. The file names are relative to the base path.
## [◆ ](#a50f67f9f53f6797a9a1c9439d849fbc5)getFilesToExport()
std::vector<string> getFilesToExport ( )
assembles a list of files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive.
Returnsa list of filenames. The file names are relative to the base path.
## [◆ ](#a4881b245e33d0ed0edc04e74b94df300)getItem()
[ExportItemInfo](struct_export_item_info.xhtml) getItem ( string *filename*, [ExportItemInfo::Type](struct_export_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) *data\_type* )
gets the respective item if existing
Parameters filenamethe filename relative to the base directory data\_typethe data type, e.g. "coordinate along x direction" Returnsa writable reference to the item. Throws an exception if not existing
## [◆ ](#a775316552fabc83e39b74beddef81334)getItemIndex()
number getItemIndex ( string *filename*, [ExportItemInfo::Type](struct_export_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) *data\_type* )
gets the index of the respective item if existing
Parameters filenamethe filename relative to the base directory data\_typethe data type, e.g. "coordinate along x direction" Returnsindex to the item in the vector items. Throws an exception if not existing
## [◆ ](#adb9208885a8e74195f267a2df949dca9)getItemsForFile()
std::vector<number> getItemsForFile ( string *filename*)
assembles a list of items which are to be exported to a specific file
Parameters filenamethe file name for which all items to be imported are searched. Returnsa list of integer indices in ascending order. Each index refers to an Item in the vector items. If no data is to be imported from the requested file, an empty list is returned.
## [◆ ](#a2522c988ad2eaf346ae7af8cd47ff11b)getModifiedFiles()
std::vector<string> getModifiedFiles ( )
assembles the complete list of files being known to this class and that are NOT to be created This is a compact view onto the contained data, since multiple items may be imported from a single file.
Returnsa list of filenames. The file names are relative to the base path.
## [◆ ](#af01172accc310310cc51e31caf936730)getModifiedFilesToExport()
std::vector<string> getModifiedFilesToExport ( )
assembles a list of modified files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive. The filenames in this list contain only those files that are not "newly created" but modified.
Returnsa list of filenames. The file names are relative to the base path.
## [◆ ](#a1488cf7e390e0191e91de8e87206b87f)getNewFilesToExport()
std::vector<string> getNewFilesToExport ( )
assembles a list of new files which are to be exported (only the files for which one selected a quantity are exported here) This is a compact view onto the contained data, since multiple items may be imported from a single file and some files may be inactive. The filenames in this list contain only those files that are not "newly created" but modified.
Returnsa list of filenames. The file names are relative to the base path.
## [◆ ](#a19fe83020c2cdfe68f4215af8cdf48cb)modifyDesign()
modifyDesign ( [Structure](class_structure.xhtml) *database*, int *sample\_number*, string *design\_path* = `""`, bool *do\_not\_check\_settings* = `false` )
modifies a design on disk
Parameters databasethe data base where all data is to be added sample\_numberthe design number which is used to define the design ident string for all data in the database design\_pathif this is empty, one takes the base\_path. Else one takes this string instead of this->base\_path do\_not\_check\_settingsif this is true, then the contents of design\_info will not be checked on validity before starting the import. This is helpful when importing multiple designs at once. If this settings object is configured to check on duplicates in the global database, then a duplicate would be found after import of the first design always leading to an error! In this case, set this parameter to true. If an error appears during import, an exception is thrown. Nevertheless, the method tries to import as much data as possible before quit.
## [◆ ](#adc5b63f5d31ab0a4abf354b4934514f7)removeFileFromList()
removeFileFromList ( string *filename*)
removes all import data from item list which is associated with the sepcified file
Parameters filenamethe file name of the file which is to be removed from import item list (exact match!). Exceptions exceptionsif the file does not exist in the list.
## [◆ ](#aa2ba2b1794ac9bad08da653ea8c99eda)setBasePath()
setBasePath ( string *path*)
sets a new base path. This includes changing the relative path definition of the already parsed files.
Parameters paththe base path
## [◆ ](#ad838ca5bc438676ab92db57b56ae56c0)setExportDesign()
setExportDesign ( number *item*, string *design\_ident* = `""` )
sets if the quantity ident of an item
Parameters itemthe index in items vector design\_identthe design ident to be exported (if empty: use the current design number) /
## [◆ ](#a4a053c513b14789817eca6aa636a5813)setExportQuantity()
setExportQuantity ( number *item*, string *quantity\_ident* = `""` )
sets if the quantity ident of an item
Parameters itemthe index in items vector quantity\_identthe quantity ident to be exported (if empty: do not export this item)
## [◆ ](#ad1067f1ab8cf433485b3a049f13d1559)setExportSource()
setExportSource ( number *item*, [ExportItemInfo::DataSource](struct_export_item_info.xhtml#ac409d3942abd5b826fb1508efc119564) *source* )
sets if the source of an item
Parameters itemthe index in items vector sourcedefines where the data object is taken from /