Skip to main content

oSP3D Script API 2024 R1

ConvertToNode< TYPE > Struct Template Reference

Last update: 16.07.2025

a struct which collects settings for convertToNode 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...
 
 ConvertToNode (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 ConvertToNode< TYPE >

a struct which collects settings for convertToNode

Template Parameters
TYPEthe field data type

Constructor & Destructor Documentation

◆ ConvertToNode()

constructor which sets suitable defaults for all members

Parameters
the_datathe 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
databasethe 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
databasethe output object is to be inserted in this object
datathe object to be converted
new_quantity_identthe quantity ident of the new object
new_design_identthe design ident of the new object

◆ compute() [2/2]

compute ( Structure  database)

converts multiple sets of samples

Parameters
databasethe output object where new objects are added to

Connect with Ansys