GAS_Reduce Class Reference

#include <GAS_Reduce.h>

Inheritance diagram for GAS_Reduce:

GAS_SubSolver SIM_Solver SIM_OptionsUser SIM_Data

List of all members.

Public Types

enum  REDUCTION_NAMES {
  REDUCE_MAX = 0, REDUCE_MIN, REDUCE_AVERAGE, REDUCE_PERCENTILE,
  REDUCE_SUM, REDUCE_SUMABS, REDUCE_SUMSQUARE, REDUCE_RMS,
  NUM_REDUCE
}

Public Member Functions

 GET_DATA_FUNC_S (GAS_NAME_FIELDDEST, FieldDstName)
 GET_DATA_FUNC_S (GAS_NAME_FIELDSOURCE, FieldSrcName)
 GET_DATA_FUNC_I ("reduction", Reduce)
 GET_DATA_FUNC_I ("scaleby", ScaleBy)
 GET_DATA_FUNC_F ("percentile", Percentile)
 GET_DATA_FUNC_B ("maskissdf", MaskIsSDF)

Protected Member Functions

 GAS_Reduce (const SIM_DataFactory *factory)
virtual ~GAS_Reduce ()
virtual bool solveGasSubclass (SIM_Engine &engine, SIM_Object *obj, SIM_Time time, SIM_Time timestep)
void doReduce (SIM_RawField *dest, const SIM_RawField *src, const SIM_RawField *maskfield)


Detailed Description

Definition at line 37 of file GAS_Reduce.h.


Member Enumeration Documentation

Enumerator:
REDUCE_MAX 
REDUCE_MIN 
REDUCE_AVERAGE 
REDUCE_PERCENTILE 
REDUCE_SUM 
REDUCE_SUMABS 
REDUCE_SUMSQUARE 
REDUCE_RMS 
NUM_REDUCE 

Definition at line 49 of file GAS_Reduce.h.


Constructor & Destructor Documentation

GAS_Reduce::GAS_Reduce ( const SIM_DataFactory factory  )  [explicit, protected]

virtual GAS_Reduce::~GAS_Reduce (  )  [protected, virtual]


Member Function Documentation

void GAS_Reduce::doReduce ( SIM_RawField dest,
const SIM_RawField src,
const SIM_RawField maskfield 
) [protected]

GAS_Reduce::GET_DATA_FUNC_B ( "maskissdf"  ,
MaskIsSDF   
)

GAS_Reduce::GET_DATA_FUNC_F ( "percentile"  ,
Percentile   
)

GAS_Reduce::GET_DATA_FUNC_I ( "scaleby"  ,
ScaleBy   
)

GAS_Reduce::GET_DATA_FUNC_I ( "reduction"  ,
Reduce   
)

GAS_Reduce::GET_DATA_FUNC_S ( GAS_NAME_FIELDSOURCE  ,
FieldSrcName   
)

GAS_Reduce::GET_DATA_FUNC_S ( GAS_NAME_FIELDDEST  ,
FieldDstName   
)

virtual bool GAS_Reduce::solveGasSubclass ( SIM_Engine engine,
SIM_Object obj,
SIM_Time  time,
SIM_Time  timestep 
) [protected, virtual]

Applies this subsolver for a single timestep. Returns true on success

Implements GAS_SubSolver.


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

Generated on Fri May 25 00:10:24 2012 for HDK by  doxygen 1.5.9