ConvertToElement< TYPE > Struct Template Reference
Last update: 16.07.2025a struct which collects settings for convertToElement More...
Public Member Functions | |
| check (Structure database) | |
| checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine. More... | |
| compute (Structure database, DataObject::ptr_type data, string new_quantity_ident, string new_design_ident) | |
| converts a single set of samples More... | |
| compute (Structure database) | |
| converts multiple sets of samples More... | |
| ConvertToElement (DataObjectContainer the_data) | |
| constructor which sets suitable defaults for all members More... | |
Public Attributes | |
| DataObjectContainer | data |
| the data set to be analyzed | |
| DataObjectContainer::string_vector_type | new_quantity_idents |
| the new idents for each quantity. The dimension and index space must fit the one of quantity_idents | |
| DataObjectContainer::string_vector_type | quantity_idents |
| the quantities to be analyzed. If a quantity ident does not exist in data, no error appears. | |
Detailed Description
template<dataobject_types TYPE>
struct ConvertToElement< TYPE >
a struct which collects settings for convertToElement
- Template Parameters
-
TYPE the field data type
Constructor & Destructor Documentation
◆ ConvertToElement()
| ConvertToElement | ( | DataObjectContainer | the_data | ) |
constructor which sets suitable defaults for all members
- Parameters
-
the_data the subset of field data to be token as input. All quantity idents are extracted. Then for each quantity a new result object will be created with design ident "mean".
Member Function Documentation
◆ check()
| check | ( | Structure | database | ) |
checks the settings on plausibility It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine.
- Parameters
-
database the SoS structure
◆ compute() [1/2]
| compute | ( | Structure | database, |
| DataObject::ptr_type | data, | ||
| string | new_quantity_ident, | ||
| string | new_design_ident | ||
| ) |
converts a single set of samples
- Parameters
-
database the output object is to be inserted in this object data the object to be converted new_quantity_ident the quantity ident of the new object new_design_ident the design ident of the new object
◆ compute() [2/2]
| compute | ( | Structure | database | ) |
converts multiple sets of samples
- Parameters
-
database the output object where new objects are added to
