CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cass::pp41 Class Reference

Threshold result based upon information from another result. More...

#include <operations.h>

+ Inheritance diagram for cass::pp41:
+ Collaboration diagram for cass::pp41:

Public Member Functions

 pp41 (const name_t &name)
 constructor More...
 
virtual void process (const CASSEvent &, result_t &)
 process event More...
 
virtual void loadSettings (size_t)
 load the settings of this pp More...
 
- Public Member Functions inherited from cass::Processor
 Processor (const name_t &name)
 constructor More...
 
virtual ~Processor ()
 virtual destructor More...
 
virtual void processEvent (const CASSEvent &event)
 process the event More...
 
virtual const result_tresult (const CASSEvent::id_t eventid=0)
 retrieve a result for a given id. More...
 
virtual void releaseEvent (const CASSEvent &event)
 tell the list that the result for event can be overwritten More...
 
result_t::shared_pointer resultCopy (const uint64_t eventid)
 retrieve histogram for id More...
 
virtual void load ()
 load the general settings More...
 
virtual void aboutToQuit ()
 function that will be called when the processor is about to be deleted More...
 
const names_tdependencies ()
 Define all processors keys a processor depends on. More...
 
void clearDependencies ()
 clear the dependenies More...
 
void clearHistograms ()
 clear the histograms More...
 
virtual void processCommand (std::string command)
 process command in pp More...
 
const name_t name () const
 retrieve the name of this processor More...
 
bool hide () const
 retrieve the hide flag of this processor More...
 
const std::string & comment () const
 retrieve the comment of this processor More...
 

Protected Member Functions

result_t::value_t checkrange (result_t::value_t val, result_t::value_t checkval)
 check if value is in range and return another value More...
 
- Protected Member Functions inherited from cass::Processor
virtual void createHistList (result_t::shared_pointer result)
 create result list. More...
 
void setupGeneral ()
 general setup of the processor More...
 
bool setupCondition (bool defaultConditionType=true)
 setup the condition. More...
 
shared_pointer setupDependency (const std::string &depVarName, const name_t &name="")
 setup the dependecy. More...
 

Protected Attributes

shared_pointer _one
 pp containing input result More...
 
shared_pointer _threshold
 pp containing threshold result More...
 
result_t::value_t _userVal
 the value that will be set More...
 
result_t::value_t _lowerBound
 the lower boundary of the range More...
 
result_t::value_t _upperBound
 the upper boundary of the range More...
 
- Protected Attributes inherited from cass::Processor
const name_t _name
 the processors name More...
 
bool _hide
 flag to tell whether this pp should be hidden in the dropdown list More...
 
std::string _comment
 optional comment that one can add to a processor. More...
 
CachedList _resultList
 the list of results More...
 
names_t _dependencies
 the list of dependencies More...
 
shared_pointer _condition
 pointer to the processor that will contain the condition More...
 

Additional Inherited Members

- Public Types inherited from cass::Processor
typedef std::tr1::shared_ptr< Processorshared_pointer
 a shared pointer of this More...
 
typedef std::string name_t
 define the name type More...
 
typedef std::list< name_tnames_t
 define the list of names More...
 
typedef CachedList::item_type result_t
 define the results More...
 
typedef CachedList::item_sp resultsp_t
 define the shared pointer to the result More...
 

Detailed Description

Threshold result based upon information from another result.

Available PostProcessors:
"41": Threshold result based upon information from another result

set the bin of a result to a user requested value when the corresponding value of the threshold is within a user requested range.

See also
Processor for a list of all commonly available cass.ini settings.
User definable Parameters:

Processor/%name%/{InputName}
processor name with result that should be thresholded. Default is Unknown.

Processor/%name%/{ThresholdName}
Processor that will be used to threshold the Input Default is Unknown.

Processor/%name%/{UserVal}
The value that will be set when the value of the corresponding bin is within the boundaries. Default is 0

Processor/%name%/{LowerLimit|UpperLimit}
The boundaries within which the value of the ThresholdName has to be in order to set the value of the result to UserVal. Default is 0.5|1.5. Both Limits are exclusive.

Author
Lutz Foucar

Definition at line 578 of file operations.h.

Constructor & Destructor Documentation

pp41::pp41 ( const name_t name)

constructor

Definition at line 699 of file operations.cpp.

References loadSettings().

Member Function Documentation

Processor::result_t::value_t pp41::checkrange ( result_t::value_t  val,
result_t::value_t  checkval 
)
protected

check if value is in range and return another value

Returns
user set value if value is in range
Parameters
valthe value that will be returned if checkval is not in range
checkvalthe value to check if it is in range

Definition at line 737 of file operations.cpp.

References _lowerBound, _upperBound, and _userVal.

Referenced by process().

void pp41::loadSettings ( size_t  )
virtual
void pp41::process ( const CASSEvent evt,
result_t result 
)
virtual

process event

only check the data area of the input

Reimplemented from cass::Processor.

Definition at line 742 of file operations.cpp.

References _one, _threshold, cass::Result< T >::begin(), checkrange(), cass::Result< T >::datasize(), cass::CASSEvent::id(), input, and cass::Result< T >::lock.

Member Data Documentation

result_t::value_t cass::pp41::_lowerBound
protected

the lower boundary of the range

Definition at line 610 of file operations.h.

Referenced by checkrange(), and loadSettings().

shared_pointer cass::pp41::_one
protected

pp containing input result

Definition at line 601 of file operations.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp41::_threshold
protected

pp containing threshold result

Definition at line 604 of file operations.h.

Referenced by loadSettings(), and process().

result_t::value_t cass::pp41::_upperBound
protected

the upper boundary of the range

Definition at line 613 of file operations.h.

Referenced by checkrange(), and loadSettings().

result_t::value_t cass::pp41::_userVal
protected

the value that will be set

Definition at line 607 of file operations.h.

Referenced by checkrange(), and loadSettings().


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