## On this page

  

 

 # ReferenceDesign Class Reference

 Last update: 16.07.2025 

defines information on imported data and files given a reference design [More...](class_reference_design.xhtml#details)

## <a name="pub-types"></a>Public Types

<a id="a41044fbbae50b73ea1a54077da1e0c9c"></a>typedef std::vector&lt; [ImportItemInfo](struct_import_item_info.xhtml) &gt; [ImportItemInfoVector](class_reference_design.xhtml#a41044fbbae50b73ea1a54077da1e0c9c) a set of data items   
 <a id="a134ae1c682574d00349ec0bdb8d7fe42"></a>typedef boost::shared\_ptr&lt; [MeshMapperBase](class_mesh_mapper_base.xhtml) &gt; [MeshMapperBasePtr](class_reference_design.xhtml#a134ae1c682574d00349ec0bdb8d7fe42) a shared pointer type for [MeshMapperBase](class_mesh_mapper_base.xhtml "An abstract base class that provides a generic API for different methods that import matching or non-...")   
 ## <a name="pub-methods"></a>Public Member Functions

 [check](class_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)  
 string [generateScriptOfSettingsDefinition](class_reference_design.xhtml#a2b231c5114f13957397147c8d2e73b6a) () Generates a Lua script that is used to build up this object. [More...](#a2b231c5114f13957397147c8d2e73b6a)  
 void [import](class_reference_design.xhtml#a979a02f7e23e0bce25332c3fe725f76c) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), int sample\_number, string design\_path="", bool do\_not\_check\_settings=false) imports a design from disk [More...](#a979a02f7e23e0bce25332c3fe725f76c)  
  [ReferenceDesign](class_reference_design.xhtml#a747693ad8a1ff2ac0aa9ef1d0fe4b70f) (string the\_base\_path) Initializes the object with the base path given and sets further defaults. [More...](#a747693ad8a1ff2ac0aa9ef1d0fe4b70f)  
  [setBasePath](class_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)  
 Modify file list

Methods to modify the file list



 [addFile\_2dGrid](class_reference_design.xhtml#a3f531f9141854fb6e661f8aa66329f96) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a CSV file with Grid information. [More...](#a3f531f9141854fb6e661f8aa66329f96)  
  [addFile\_3dGrid](class_reference_design.xhtml#a54f99da4a501ea028ec621577ff149cb) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a CSV file with Grid information. [More...](#a54f99da4a501ea028ec621577ff149cb)  
  [addFile\_Abaqus](class_reference_design.xhtml#afd5c422a5396fc7f6fc9d67639056f22) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in Abaqus format. [More...](#afd5c422a5396fc7f6fc9d67639056f22)  
  [addFile\_ANSYS\_APDL](class_reference_design.xhtml#ad910539acbf3b9335eb049ead8d0eab1) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from an ANSYS Mechanical APDL file either in APDL-style format, or in cdb blocked as well as unblocked format. [More...](#ad910539acbf3b9335eb049ead8d0eab1)  
  [addFile\_ANSYS\_RST](class_reference_design.xhtml#a1b5ff1759d329f5a852a0e14e29343c0) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from an ANSYS binary structural or coupled-field analysis file. [More...](#a1b5ff1759d329f5a852a0e14e29343c0)  
  [addFile\_Image](class_reference_design.xhtml#a1275367105e2c8901916e138e7cfca39) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in a pixel image format. [More...](#a1275367105e2c8901916e138e7cfca39)  
  [addFile\_LSDyna\_Dynain](class_reference_design.xhtml#a1b8a91fa4a2873763aa6cc4ab27527c6) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) adds information from a file in LS-DYNA Dynain format. [More...](#a1b8a91fa4a2873763aa6cc4ab27527c6)  
  [addFile\_LSPrePost](class_reference_design.xhtml#ac4b1f9b78214f1ad46dead046c98659e) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) adds information from a file in LS-PrePost (LS-DYNA) format. [More...](#ac4b1f9b78214f1ad46dead046c98659e)  
  [addFile\_NastranInput](class_reference_design.xhtml#a65b79da7516c43d19afddd630376e478) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in NASTRAN format. [More...](#a65b79da7516c43d19afddd630376e478)  
  [addFile\_PamstampDataAsc](class_reference_design.xhtml#abb1734d74f4c44bea421e20aa23e963b) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in NASTRAN format. [More...](#abb1734d74f4c44bea421e20aa23e963b)  
  [addFile\_PERMAS](class_reference_design.xhtml#ab673c9293b5fc4fc3c8c2cbd5e663adb) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in PERMAS format. [More...](#ab673c9293b5fc4fc3c8c2cbd5e663adb)  
  [addFile\_STL](class_reference_design.xhtml#ad5c4c8b3993209b6356f59233da1da48) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in STL format. [More...](#ad5c4c8b3993209b6356f59233da1da48)  
  [addFile\_ElementDataCSV](class_reference_design.xhtml#a69cfbc9c84840bb99ee4c2406e8982ca) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds element data information from a file in CSV format. [More...](#a69cfbc9c84840bb99ee4c2406e8982ca)  
  [addFile\_NodeDataCSV](class_reference_design.xhtml#a897d79d7afae207e2a37efe46cf6e099) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds node data information from a file in CSV format. [More...](#a897d79d7afae207e2a37efe46cf6e099)  
  [addFile\_SignalMeshCSV](class_reference_design.xhtml#a65638c0dc45c447e1ce31c172c4e568a) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds node data information from a signal file in CSV format. [More...](#a65638c0dc45c447e1ce31c172c4e568a)  
  [addFile\_SignalDataCSV](class_reference_design.xhtml#ac610b2839029ab3554d6b8961cd74f0b) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds node data information from a signal file in CSV format. [More...](#ac610b2839029ab3554d6b8961cd74f0b)  
  [addFile\_FLUENT\_CSV](class_reference_design.xhtml#a1cbe5b36f92cdfe01c6f2acbaf34d590) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) adds information from a file in FLUENT result CSV format. [More...](#a1cbe5b36f92cdfe01c6f2acbaf34d590)  
  [addFile\_VTK](class_reference_design.xhtml#a34d895ea81537ef302bc29c126356eb9) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), string filename) Adds information from a file in VTK format. [More...](#a34d895ea81537ef302bc29c126356eb9)  
  [removeFileFromList](class_reference_design.xhtml#adc5b63f5d31ab0a4abf354b4934514f7) (string filename) removes all import data from item list which is associated with the sepcified file [More...](#adc5b63f5d31ab0a4abf354b4934514f7)  
 std::vector&lt; string &gt; [getFiles](class_reference_design.xhtml#a933cb1c407847079e005bdb46056cbfd) () assembles the complete list of files being known to this class [More...](#a933cb1c407847079e005bdb46056cbfd)  
 std::vector&lt; string &gt; [getFilesToImport](class_reference_design.xhtml#a834da9fe4249630dcb02fff987c41a22) () Assembles a list of files which are to be imported (only the files for which one selected "import" are exported here) [More...](#a834da9fe4249630dcb02fff987c41a22)  
 Modify file item properties

Methods to modify file item properties



 [addItem](class_reference_design.xhtml#a51da3543fdd29777389205577f4a2849) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), [ImportItemInfo](struct_import_item_info.xhtml) new\_item) adds a single item to trhe list of import data [More...](#a51da3543fdd29777389205577f4a2849)  
  [setImportItem](class_reference_design.xhtml#a39cc40da8396870fcb5ffce2732ad45a) (number item, bool do\_import) Sets if the item is to be imported There is no error checking! [More...](#a39cc40da8396870fcb5ffce2732ad45a)  
  [setImportIdent](class_reference_design.xhtml#a16c93a180125b6a7d85a41bba4cbff04) (number item, string ident, [Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) Sets the new ident used for import The ident is automatically modified to be unique and allowed. Further, the list of items is resorted! [More...](#a16c93a180125b6a7d85a41bba4cbff04)  
 <a id="ab71d843a916619570506d44ba030f4c2"></a> [sortItems](class_reference_design.xhtml#ab71d843a916619570506d44ba030f4c2) () sorts the vector of item information   
 std::vector&lt; number &gt; [getItemsForFile](class_reference_design.xhtml#accd09dc4f762c4b4b2e533e625b1a0ea) (string filename) assembles a list of items which are to be imported from a specific file [More...](#accd09dc4f762c4b4b2e533e625b1a0ea)  
 number [getItemIndex](class_reference_design.xhtml#af5edf7e140f1826d224c8d7a2417b2cb) (string filename, [ImportItemInfo::Type](struct_import_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7) data\_type, string input\_ident, number column=0) gets the index of the respective item if existing [More...](#af5edf7e140f1826d224c8d7a2417b2cb)  
 <a id="aa821bec12eaa7e0f649397c9675ff505"></a> [clear](class_reference_design.xhtml#aa821bec12eaa7e0f649397c9675ff505) () deletes all import items   
 Modify mesh mapper

Methods to control mesh mapper settings



 [setMeshMapper](class_reference_design.xhtml#a74b36e749ed3b693b484d81e53d1f711) ([MeshMapperBase](class_mesh_mapper_base.xhtml) mapper) sets the (in)compatible mesh mapper object [More...](#a74b36e749ed3b693b484d81e53d1f711)  
 [MeshMapperBase](class_mesh_mapper_base.xhtml) [meshMapper](class_reference_design.xhtml#a34271ccf735c92b0a624cd9ec42e3988) () [MeshMapperBase](class_mesh_mapper_base.xhtml) [meshMapperRef](class_reference_design.xhtml#a135afdadbeabf58cddabd5936c3d4f62) () ## <a name="pub-attribs"></a>Public Attributes

string [base\_path](class_reference_design.xhtml#a1be53c8e392d898f99ddc804ff403c84) Specifies the base path. Must be changed only via [setBasePath()](class_reference_design.xhtml#aa2ba2b1794ac9bad08da653ea8c99eda "sets a new base path. This includes changing the relative path definition of the already parsed files...")! [More...](#a1be53c8e392d898f99ddc804ff403c84)  
 <a id="ab5607495ca904981a64eba8a947560b8"></a>bool [check\_on\_duplicate\_idents\_in\_database](class_reference_design.xhtml#ab5607495ca904981a64eba8a947560b8) defines if quantities to be imported must not exist in the global database In this case, all methods will propose idents which make the new imported data unique.   
 <a id="a6ae81b54d8b4c8017039fde932ea27d9"></a>[ImportItemInfoVector](class_reference_design.xhtml#a41044fbbae50b73ea1a54077da1e0c9c) [items](class_reference_design.xhtml#a6ae81b54d8b4c8017039fde932ea27d9) stores all parsed data item information   
 <a id="details" name="details"></a>## 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.

Note, the 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_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 &amp; Destructor Documentation

<a id="a747693ad8a1ff2ac0aa9ef1d0fe4b70f"></a>## [◆ ](#a747693ad8a1ff2ac0aa9ef1d0fe4b70f)ReferenceDesign()

 [ReferenceDesign](class_reference_design.xhtml)  ( string  *the\_base\_path*) 

Initializes the object with the base path given and sets further defaults.

Parameters the\_base\_pathDefines the base path. Refer to base\_path for further remarks, 



## Member Function Documentation

<a id="a3f531f9141854fb6e661f8aa66329f96"></a>## [◆ ](#a3f531f9141854fb6e661f8aa66329f96)addFile\_2dGrid()

 addFile\_2dGrid  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a CSV file with Grid information.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory. Otherwise it will be tried to interpret the filename as absolute path 



<a id="a54f99da4a501ea028ec621577ff149cb"></a>## [◆ ](#a54f99da4a501ea028ec621577ff149cb)addFile\_3dGrid()

 addFile\_3dGrid  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a CSV file with Grid information.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory. Otherwise it will be tried to interpret the filename as absolute path 



<a id="afd5c422a5396fc7f6fc9d67639056f22"></a>## [◆ ](#afd5c422a5396fc7f6fc9d67639056f22)addFile\_Abaqus()

 addFile\_Abaqus  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in Abaqus format.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory. Otherwise it will be tried to interpret the filename as absolute path 



<a id="ad910539acbf3b9335eb049ead8d0eab1"></a>## [◆ ](#ad910539acbf3b9335eb049ead8d0eab1)addFile\_ANSYS\_APDL()

 addFile\_ANSYS\_APDL  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from an ANSYS Mechanical APDL file either in APDL-style format, or in cdb blocked as well as unblocked format.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Interpred either relative to the base path or to the working directory, or interpreted as absolute path. If none of these options match an exsisting file, an exception will be thrown 



<a id="a1b5ff1759d329f5a852a0e14e29343c0"></a>## [◆ ](#a1b5ff1759d329f5a852a0e14e29343c0)addFile\_ANSYS\_RST()

 addFile\_ANSYS\_RST  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from an ANSYS binary structural or coupled-field analysis file.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Interpred either relative to the base path or to the working directory, or interpreted as absolute path. If none of these options match an exsisting file, an exception will be thrown 



<a id="a69cfbc9c84840bb99ee4c2406e8982ca"></a>## [◆ ](#a69cfbc9c84840bb99ee4c2406e8982ca)addFile\_ElementDataCSV()

 addFile\_ElementDataCSV  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds element data information from a file in CSV format.

Only element data items are supported. If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databasethe current database where the items are to be imported filenamethe file to be parsed. Is relative the base\_path or (if this is not existing, take it as absolute path or relative to working dir) 



<a id="a1cbe5b36f92cdfe01c6f2acbaf34d590"></a>## [◆ ](#a1cbe5b36f92cdfe01c6f2acbaf34d590)addFile\_FLUENT\_CSV()

 addFile\_FLUENT\_CSV  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

adds information from a file in FLUENT result CSV format.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory or it will be tried to interpret the filename as absolute path 



<a id="a1275367105e2c8901916e138e7cfca39"></a>## [◆ ](#a1275367105e2c8901916e138e7cfca39)addFile\_Image()

 addFile\_Image  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in a pixel image format.

Multiple data items per file are supported. It is checked on validity using the pixel dimensions (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Interpred either relative to the base path or to the working directory, or interpreted as absolute path. If none of these options match an exsisting file, an exception will be thrown 



<a id="a1b8a91fa4a2873763aa6cc4ab27527c6"></a>## [◆ ](#a1b8a91fa4a2873763aa6cc4ab27527c6)addFile\_LSDyna\_Dynain()

 addFile\_LSDyna\_Dynain  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

adds information from a file in LS-DYNA Dynain format.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory or it will be tried to interpret the filename as absolute path 



<a id="ac4b1f9b78214f1ad46dead046c98659e"></a>## [◆ ](#ac4b1f9b78214f1ad46dead046c98659e)addFile\_LSPrePost()

 addFile\_LSPrePost  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

adds information from a file in LS-PrePost (LS-DYNA) format.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory or it will be tried to interpret the filename as absolute path 



<a id="a65b79da7516c43d19afddd630376e478"></a>## [◆ ](#a65b79da7516c43d19afddd630376e478)addFile\_NastranInput()

 addFile\_NastranInput  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in NASTRAN format.

The file will be read and interpreted as input file (\*.dat, \*bdf) with a clearly and reliable defined data structure described in [MSC Nastran Quick Reference Guide](http://simcompanion.mscsoftware.com/infocenter/index?page=contentchannel=DOCUMENTATIONcat=MSC__MD_NASTRAN_DOCUMENTATION) Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive).

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Is relative to the base\_path or if this is not existing, try to take it as absolute path or relative to the working dir. 



<a id="a897d79d7afae207e2a37efe46cf6e099"></a>## [◆ ](#a897d79d7afae207e2a37efe46cf6e099)addFile\_NodeDataCSV()

 addFile\_NodeDataCSV  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds node data information from a file in CSV format.

Only node data items are supported. If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databasethe current database where the items are to be imported filenamethe file to be parsed. Is relative the base\_path or (if this is not existing, take it as absolute path or relative to working dir) 



<a id="abb1734d74f4c44bea421e20aa23e963b"></a>## [◆ ](#abb1734d74f4c44bea421e20aa23e963b)addFile\_PamstampDataAsc()

 addFile\_PamstampDataAsc  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in NASTRAN format.

The file will be read and interpreted as data file. At this time we don't know any standard or at least a common format for Nastran output data. In fact, we don't know where the data format comes from... Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Is relative to the base\_path or if this is not existing, try to take it as absolute path or relative to the working dir. 



<a id="ab673c9293b5fc4fc3c8c2cbd5e663adb"></a>## [◆ ](#ab673c9293b5fc4fc3c8c2cbd5e663adb)addFile\_PERMAS()

 addFile\_PERMAS  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in PERMAS format.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory or it will be tried to interpret the filename as absolute path 



<a id="ac610b2839029ab3554d6b8961cd74f0b"></a>## [◆ ](#ac610b2839029ab3554d6b8961cd74f0b)addFile\_SignalDataCSV()

 addFile\_SignalDataCSV  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds node data information from a signal file in CSV format.

Only node data items are supported. If the data items are already existing, their names will be changed. The vector is reordered.

Only the data and not the mesh will be imported.

Parameters databaseThe database where the items are to be imported filenameThe file to be parsed. As first guess, the path is interpreted relative to the base\_path. If this fails, the path is read as absolute path or - as last option - relative to the working dir. 



<a id="a65638c0dc45c447e1ce31c172c4e568a"></a>## [◆ ](#a65638c0dc45c447e1ce31c172c4e568a)addFile\_SignalMeshCSV()

 addFile\_SignalMeshCSV  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds node data information from a signal file in CSV format.

Only node data items are supported. If the data items are already existing, their names will be changed. The vector is reordered.

Both data and mesh will be imported.

Parameters databaseThe database where the items are to be imported filenameThe file to be parsed. As first guess, the path is interpreted relative to the base\_path. If this fails, the path is read as absolute path or - as last option - relative to the working dir. 



<a id="ad5c4c8b3993209b6356f59233da1da48"></a>## [◆ ](#ad5c4c8b3993209b6356f59233da1da48)addFile\_STL()

 addFile\_STL  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in STL format.

Only geometric information can be imported. STL import makes only sense in combination with incompatible mesh mappers.

Parameters databasethe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory or it will be tried to interpret the filename as absolute path 



<a id="a34d895ea81537ef302bc29c126356eb9"></a>## [◆ ](#a34d895ea81537ef302bc29c126356eb9)addFile\_VTK()

 addFile\_VTK  ( [Structure](class_structure.xhtml)  *database*,    string  *filename*   ) 

Adds information from a file in VTK format.

Multiple data items per file are supported. If the file consists geometric information, it is checked on validity (with a warning and being added inactive). If the data items are already existing, their names will be changed. The vector is reordered.

Parameters databaseThe current database where the items are to be imported filenameThe file to be parsed. Relative to the base path, or if not existing, relative to the working directory. Otherwise it will be tried to interpret the filename as absolute path 



<a id="a51da3543fdd29777389205577f4a2849"></a>## [◆ ](#a51da3543fdd29777389205577f4a2849)addItem()

 addItem  ( [Structure](class_structure.xhtml)  *database*,    [ImportItemInfo](struct_import_item_info.xhtml)  *new\_item*   ) 

adds a single item to trhe list of import data

Parameters databasethe database we refer to new\_itemthe new item NoteThis method is used for directly modifying the data. It is not intended to be used by the user/GUI, but by [generateScriptOfSettingsDefinition()](class_reference_design.xhtml#a2b231c5114f13957397147c8d2e73b6a "Generates a Lua script that is used to build up this object. "). 



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

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

checks if the settings are valid and produces an error.

Parameters databasethe data base 



<a id="a2b231c5114f13957397147c8d2e73b6a"></a>## [◆ ](#a2b231c5114f13957397147c8d2e73b6a)generateScriptOfSettingsDefinition()

 string generateScriptOfSettingsDefinition  ( ) 

Generates a Lua script that is used to build up this object.

ReturnsThe script code. Ends with a newline. NoteThis script works only for the global reference design (due to restrictions in itself and other classes) 



<a id="a933cb1c407847079e005bdb46056cbfd"></a>## [◆ ](#a933cb1c407847079e005bdb46056cbfd)getFiles()

 std::vector&lt; string &gt; 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. 



<a id="a834da9fe4249630dcb02fff987c41a22"></a>## [◆ ](#a834da9fe4249630dcb02fff987c41a22)getFilesToImport()

 std::vector&lt; string &gt; getFilesToImport  ( ) 

Assembles a list of files which are to be imported (only the files for which one selected "import" 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. 



<a id="af5edf7e140f1826d224c8d7a2417b2cb"></a>## [◆ ](#af5edf7e140f1826d224c8d7a2417b2cb)getItemIndex()

 number getItemIndex  ( string  *filename*,    [ImportItemInfo::Type](struct_import_item_info.xhtml#a1d1cfd8ffb84e947f82999c682b666a7)  *data\_type*,    string  *input\_ident*,    number  *column* = `0`   ) 

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" input\_identthe input ident, e.g. "thickness" columnthe column index for tensor fields (else 0) Returnsindex to the item in the vector items. Throws an exception if not existing 



<a id="accd09dc4f762c4b4b2e533e625b1a0ea"></a>## [◆ ](#accd09dc4f762c4b4b2e533e625b1a0ea)getItemsForFile()

 std::vector&lt; number &gt; getItemsForFile  ( string  *filename*) 

assembles a list of items which are to be imported from 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. 



<a id="a979a02f7e23e0bce25332c3fe725f76c"></a>## [◆ ](#a979a02f7e23e0bce25332c3fe725f76c)import()

 void import  ( [Structure](class_structure.xhtml)  *database*,    int  *sample\_number*,    string  *design\_path* = `""`,    bool  *do\_not\_check\_settings* = `false`   ) 

imports a design from 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 new data in the database design\_pathif this is empty, one takes the base\_path. Else one takes this string instead of this-&gt;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. ReturnsReturns an projection error report for each imported quantity. If no projection error occured during import, an empty quantity report will be returned. See [DesignProjectionErrorReport](struct_design_projection_error_report.xhtml "The DesignProjectionError struct. ") for further details If an error appears during import, an exception is thrown. Nevertheless, the method tries to import as much data as possible before quit. 



<a id="a34271ccf735c92b0a624cd9ec42e3988"></a>## [◆ ](#a34271ccf735c92b0a624cd9ec42e3988)meshMapper()

 [MeshMapperBase](class_mesh_mapper_base.xhtml) meshMapper  ( ) 

Returnsa reference to the (in)compatible mesh mapper object 



<a id="a135afdadbeabf58cddabd5936c3d4f62"></a>## [◆ ](#a135afdadbeabf58cddabd5936c3d4f62)meshMapperRef()

 [MeshMapperBase](class_mesh_mapper_base.xhtml) meshMapperRef  ( ) 

Returnsa modifyable reference to the (in)compatible mesh mapper object 



<a id="adc5b63f5d31ab0a4abf354b4934514f7"></a>## [◆ ](#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 std::exceptionif the file does not exist in the list. 



<a id="aa2ba2b1794ac9bad08da653ea8c99eda"></a>## [◆ ](#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 



<a id="a16c93a180125b6a7d85a41bba4cbff04"></a>## [◆ ](#a16c93a180125b6a7d85a41bba4cbff04)setImportIdent()

 setImportIdent  ( number  *item*,    string  *ident*,    [Structure](class_structure.xhtml)  *database*   ) 

Sets the new ident used for import The ident is automatically modified to be unique and allowed. Further, the list of items is resorted!

Parameters itemthe index in items vector identthe new value of "imported\_ident" databasethe database (used for checking the ident on being allowed). 



<a id="a39cc40da8396870fcb5ffce2732ad45a"></a>## [◆ ](#a39cc40da8396870fcb5ffce2732ad45a)setImportItem()

 setImportItem  ( number  *item*,    bool  *do\_import*   ) 

Sets if the item is to be imported There is no error checking!

Parameters itemthe index in items vector do\_importthe new value of "do\_import". 



<a id="a74b36e749ed3b693b484d81e53d1f711"></a>## [◆ ](#a74b36e749ed3b693b484d81e53d1f711)setMeshMapper()

 setMeshMapper  ( [MeshMapperBase](class_mesh_mapper_base.xhtml)  *mapper*) 

sets the (in)compatible mesh mapper object

Parameters mapperthe new mapping handler 



## Member Data Documentation

<a id="a1be53c8e392d898f99ddc804ff403c84"></a>## [◆ ](#a1be53c8e392d898f99ddc804ff403c84)base\_path

 string base\_path

Specifies the base path. Must be changed only via [setBasePath()](class_reference_design.xhtml#aa2ba2b1794ac9bad08da653ea8c99eda "sets a new base path. This includes changing the relative path definition of the already parsed files...")!

base\_path should always point to an existing absolute filesystem directory otherwise an exception may occour during program execution.