ImportItemInfo Struct Reference
Last update: 16.07.2025defines a data item which was found in an input file More...
Public Types | |
| enum | enum_format_type { NO_FILE = 0, LSDYNA, NASTRAN, NASTRAN_DATA, IMAGE, PERMAS, STL, SRB_NODE_DATA, CSV_ELEMENT_DATA, CSV_NODE_DATA, CSV_SIGNAL_DATA, ABAQUS, CSV_GRID2D, CSV_GRID3D, LSDYNA_LSPREPOST, VTK, ANSYS_RST, ANSYS_APDL, CSV_FLUENT, CSV_SIGNAL_MESH } |
| defines the format of a file More... | |
| enum | Type { MESH = 0, ELEMENT, NODE, INTPT, SCALAR, NODE_COOR_X, NODE_COOR_Y, NODE_COOR_Z, NODE_COOR_DEVIATION_X, NODE_COOR_DEVIATION_Y, NODE_COOR_DEVIATION_Z, NODE_COOR_DEVIATION_NORM } |
| defines the type of data item More... | |
Public Member Functions | |
| ImportItemInfo (string par_filename, enum_format_type par_file_format, Type par_data_type, number par_column, string par_input_ident, string par_imported_ident="", MetaStructure par_mesh_info=MetaStructure(), bool par_do_import=true) | |
| constructor More... | |
| ImportItemInfo (ImportItemInfo other) | |
| copy constructor More... | |
| ImportItemInfo () | |
| Default constructor. More... | |
| ImportItemInfo | operator= (ImportItemInfo other) |
| copy-assign operator More... | |
Static Public Member Functions | |
| static dataobject_types | objectType (ImportItemInfo::Type type) |
| static string | toScript (ImportItemInfo::enum_format_type type) |
| static string | toScript (ImportItemInfo::Type type) |
| static string | toString (ImportItemInfo::enum_format_type type) |
| static string | toString (ImportItemInfo::Type type) |
Public Attributes | |
| number | column |
| if it is a data object, then this defines the column in the data matrix (0..n-1) | |
| Type | data_type |
| the kind of data | |
| bool | do_import |
| defines if this data item is to be imported. may be changed by the user. if the data type is a "mesh" then it cannot be "disabled" | |
| enum_format_type | file_format |
| the source file format | |
| string | filename |
| the name of the source file relative to the base path | |
| immutable | |
| string | imported_ident |
| the ident of the data item as being imported. must be unique for the data type. is empty for geometry data. may be changed by the user. | |
| string | input_ident |
| the ident of the data item as found in the file. duplicates are allowed. is empty if geometry data | |
| mutable | |
Detailed Description
defines a data item which was found in an input file
It encapsulates information being found on this data item in the specific file. It knows:
- scalar data, node data, element data, intpt data. If any information on FEM meshes is found, it is marked as
- Further it knows: the ident, the column index in the data matrix (for tensors), the ident to be used after import...
- For mesh data, it also remembers the mesh itself. This is required to check persistency if another mesh is to be added (Sometimes, the mesh is defined in two files - no error. Sometimes one wants to add two meshes from two files - error.).
Member Enumeration Documentation
◆ enum_format_type
| enum enum_format_type |
defines the format of a file
- Note
- In order to stay compatible with existing script files, do only append new items to this list! This list will directly influence the sort order in the item vector
◆ Type
| enum Type |
defines the type of data item
- Note
- In order to stay compatible with existing script files, do only append new items to this list! This list will directly influence the sort order in the item vector
Constructor & Destructor Documentation
◆ ImportItemInfo() [1/3]
| ImportItemInfo | ( | string | par_filename, |
| enum_format_type | par_file_format, | ||
| Type | par_data_type, | ||
| number | par_column, | ||
| string | par_input_ident, | ||
| string | par_imported_ident = "", |
||
| MetaStructure | par_mesh_info = MetaStructure(), |
||
| bool | par_do_import = true |
||
| ) |
constructor
- Parameters
-
par_filename sets filename par_file_format sets file_format par_data_type sets data_type par_column sets column (0..n-1) par_input_ident sets input_ident par_mesh_info sets mesh_info par_imported_ident sets imported_ident. If it is equal to "", then imported_ident will be equal to input_ident par_do_import sets do_import /
◆ ImportItemInfo() [2/3]
| ImportItemInfo | ( | ImportItemInfo | other | ) |
copy constructor
- Parameters
-
other the source object
◆ ImportItemInfo() [3/3]
| ImportItemInfo | ( | ) |
Default constructor.
- Note
- Do not use it! It is a dummy for usage with SWIG!
Member Function Documentation
◆ objectType()
|
static |
- Parameters
-
type the given data type
- Returns
- returns the dataobject type that is assocoiated with this kind of data
◆ operator=()
| ImportItemInfo operator= | ( | ImportItemInfo | other | ) |
copy-assign operator
- Parameters
-
other the source object to be copy-assigned
◆ toScript() [1/2]
|
static |
- Parameters
-
type the given file format
- Returns
- a string representation of the enum used in Lua code
◆ toScript() [2/2]
|
static |
- Parameters
-
type the given data type
- Returns
- a string representation of the enum used in Lua code
◆ toString() [1/2]
|
static |
- Parameters
-
type the given file format
- Returns
- a string representation of the enum
◆ toString() [2/2]
|
static |
- Parameters
-
type the given data type
- Returns
- a string representation of the enum
