API Documentation
Loading...
Searching...
No Matches
DesignParameterAccumulator Class Referencefinal

Searches a model heirarchy and pulls all parameter data based on the AccumationMode settings. More...

#include <DesignParameterAccumulator.h>

Inheritance diagram for DesignParameterAccumulator:
[legend]
Collaboration diagram for DesignParameterAccumulator:
[legend]

Public Types

enum  AccumulateMode {
  e_get_max_min , e_get_average , e_get_variance , e_get_std_dev ,
  e_get_strings , e_get_total , e_get_indices , e_get_floats
}
 
- Public Types inherited from ModelIterator
enum  ParseResult { e_continue_parsing , e_do_not_parse_children , e_finish_parsing }
 

Public Member Functions

void accumulate (const DesignObject &object, fltp08 known_avg=Constant< fltp08 >::Invalid)
 
void accumulate (fltp08 value, const uint01 &dim=X, bool to_unit=true)
 
void addToTotal (fltp08 value)
 
void clear ()
 
 DesignParameterAccumulator (const DesignParameter &design_parameter, BitFlag mode=BitFlag(0))
 
void setCollectVerticesByPrimitive (PrimitiveProperty vertex_collection_primitive)
 
void setToDefaults (const DesignObject &object)
 
DesignObject::DesignObjectType type ()
 
- Public Member Functions inherited from ModelIterator
Model currentModel () const
 
 ModelIterator ()
 
 ModelIterator (Buffer< Model > models)
 
 ModelIterator (const Model &model)
 
void parseAll ()
 
void parseAll (const Buffer< Model > &models)
 
void parseAll (const Model &model)
 
ParseResult parseNext ()
 

Public Attributes

BitFlag accumulate_mode
 
bool add_commas = false
 
fltp08 average = Constant<fltp08>::Invalid
 
String default_value
 
Buffer< fltp08float_values
 
bool include_unit_symbols = true
 
Buffer< uint04indices
 
bool is_normal_prop = false
 
fltp08 lower_std_dev = 0.0
 
fltp08 lower_variance = 0.0
 
fltp08 max = Constant<fltp08>::Min
 
uint04 max_num_of_decimals = Constant<uint04>::Max
 
uint04 max_num_of_values = Constant<uint04>::Max
 
fltp08 min = Constant<fltp08>::Max
 
uint04 min_digits = 0
 
uint04 min_num_of_decimals = 0
 
ConstPointer< Unitoverride_unit
 
DesignParameter parameter
 
bool recursive_matrix = false
 
String string_cache
 
Buffer< Stringstring_values
 
uint04 total_count = 0
 
uint04 total_lower = 0
 
uint04 total_upper = 0
 
fltp08 total_value = 0.0
 
Matrix< fltp08transform = Matrix<fltp08>(1.0)
 
fltp08 upper_std_dev = 0.0
 
fltp08 upper_variance = 0.0
 
bool use_defaults = false
 
- Public Attributes inherited from ModelIterator
bool depth_first = true
 
std::function< bool(const Model &, const Geometry &)> geo_filter
 
bool is_recursive = true
 
std::function< bool(const Model &, const Material &)> material_filter
 
PrimitiveProperty material_property = PrimitiveProperty::Solid
 
std::function< bool(const Model &)> model_filter
 
bool post_process_model = false
 
bool process_geometry = true
 
bool process_material = false
 
bool process_model = true
 
bool use_unit = false
 

Protected Attributes

bool is_design_index = false
 
bool is_matrix_prop = false
 
bool is_special_field = false
 
bool is_vertex_index = false
 
DesignObject::DesignObjectType m_design_type = DesignObject::DesignObjectType::e_model
 
PrimitiveProperty m_vertex_collection_primitive = PrimitiveProperty::Vertices
 
uint04 property_index = Constant<uint04>::Invalid
 
fltp08 total_value_c = 0.0
 
- Protected Attributes inherited from ModelIterator
Buffer< uint04m_model_parent_child_count
 
Buffer< Modelm_model_parent_stack
 
Buffer< Modelm_model_stack
 

Additional Inherited Members

- Protected Member Functions inherited from ModelIterator
Model popNextModel ()
 
void removeFromPostProcessStack ()
 

Detailed Description

Searches a model heirarchy and pulls all parameter data based on the AccumationMode settings.


Member Enumeration Documentation

◆ AccumulateMode

Enumerator
e_get_max_min 
e_get_average 
e_get_variance 
e_get_std_dev 
e_get_strings 
e_get_total 
e_get_indices 
e_get_floats 

Constructor & Destructor Documentation

◆ DesignParameterAccumulator()

DesignParameterAccumulator ( const DesignParameter & design_parameter,
BitFlag mode = BitFlag(0) )
explicit

Member Function Documentation

◆ accumulate() [1/2]

void accumulate ( const DesignObject & object,
fltp08 known_avg = Constantfltp08 >::Invalid )

◆ accumulate() [2/2]

void accumulate ( fltp08 value,
const uint01 & dim = X,
bool to_unit = true )

◆ addToTotal()

void addToTotal ( fltp08 value)

◆ clear()

void clear ( )

◆ setCollectVerticesByPrimitive()

void setCollectVerticesByPrimitive ( PrimitiveProperty vertex_collection_primitive)

◆ setToDefaults()

void setToDefaults ( const DesignObject & object)

◆ type()

Member Data Documentation

◆ accumulate_mode

BitFlag accumulate_mode

◆ add_commas

bool add_commas = false

◆ average

◆ default_value

String default_value

◆ float_values

Buffer<fltp08> float_values

◆ include_unit_symbols

bool include_unit_symbols = true

◆ indices

Buffer<uint04> indices

◆ is_design_index

bool is_design_index = false
protected

◆ is_matrix_prop

bool is_matrix_prop = false
protected

◆ is_normal_prop

bool is_normal_prop = false

◆ is_special_field

bool is_special_field = false
protected

◆ is_vertex_index

bool is_vertex_index = false
protected

◆ lower_std_dev

fltp08 lower_std_dev = 0.0

◆ lower_variance

fltp08 lower_variance = 0.0

◆ m_design_type

◆ m_vertex_collection_primitive

PrimitiveProperty m_vertex_collection_primitive = PrimitiveProperty::Vertices
protected

◆ max

fltp08 max = Constant<fltp08>::Min

◆ max_num_of_decimals

uint04 max_num_of_decimals = Constant<uint04>::Max

◆ max_num_of_values

uint04 max_num_of_values = Constant<uint04>::Max

◆ min

fltp08 min = Constant<fltp08>::Max

◆ min_digits

uint04 min_digits = 0

◆ min_num_of_decimals

uint04 min_num_of_decimals = 0

◆ override_unit

ConstPointer<Unit> override_unit

◆ parameter

DesignParameter parameter

◆ property_index

uint04 property_index = Constant<uint04>::Invalid
protected

◆ recursive_matrix

bool recursive_matrix = false

◆ string_cache

String string_cache

◆ string_values

Buffer<String> string_values

◆ total_count

uint04 total_count = 0

◆ total_lower

uint04 total_lower = 0

◆ total_upper

uint04 total_upper = 0

◆ total_value

fltp08 total_value = 0.0

◆ total_value_c

fltp08 total_value_c = 0.0
protected

◆ transform

Matrix<fltp08> transform = Matrix<fltp08>(1.0)

◆ upper_std_dev

fltp08 upper_std_dev = 0.0

◆ upper_variance

fltp08 upper_variance = 0.0

◆ use_defaults

bool use_defaults = false

The documentation for this class was generated from the following file: