Skip to main content

optiSLang 3D Postprocessing Script API 2024 R2 SP02

ExtractExtremalScalars< TYPE > Class Template Reference

Last update: 16.07.2025

An abstract base class to compute the extremal scalar quantity per design from all field indices given in indices as well as for all field quantities found within the dataobject filter. More...

Public Types

typedef std::vector< std::pair< std::size_t, std::size_t > > index_type
 A sequential index container storing the part and entity index. A sequential index container storing the part index as first argument and the entity index of this part as second argument.
 
typedef std::vector< DataObjectContainer::string_vector_type > quantity_map_type
 A vector of vectors containing default quantity idents for each quantity (row) and each index (column) passed to the constructor.
 

Public Member Functions

 compute (Structure database)
 Performs the action using the defined settings. More...
 
std::vector< string > determineObjectsToBeReplaced (Structure database)
 Determines if any result objects already exist in the database. More...
 
virtual string setNewQuantityIdentTemplate (string ident)=0
 Sets the quantity ident template used to generarte new quantity idents. More...
 

Public Attributes

DataObjectContainer data
 the data set to be analyzed
 
bool overwrite_existing
 is true if already existing output data objects will be replaced. If true, also all depending objects of the already existing one will be deleted.
 
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>
class ExtractExtremalScalars< TYPE >

An abstract base class to compute the extremal scalar quantity per design from all field indices given in indices as well as for all field quantities found within the dataobject filter.

Date
-2015
Template Parameters
TYPEthe field data type

Member Function Documentation

◆ compute()

compute ( Structure  database)
inherited

Performs the action using the defined settings.

Parameters
databasethe output object where new objects are added to

◆ determineObjectsToBeReplaced()

std::vector< string > determineObjectsToBeReplaced ( Structure  database)
inherited

Determines if any result objects already exist in the database.

Parameters
databasethe SoS structure
Returns
It returns a list of human readable idents. This list is empty if no duplicates exist. The size of the list is the number of objects to be replaced.

◆ setNewQuantityIdentTemplate()

virtual string setNewQuantityIdentTemplate ( string  ident)
pure virtual

Sets the quantity ident template used to generarte new quantity idents.

Parameters
identThe new quantity ident template
Returns
The new quantity ident template value

Implemented in ExtractMaximumScalars< TYPE >, and ExtractMinimumScalars< TYPE >.

Connect with Ansys