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

Constant Value processor. More...

#include <operations.h>

+ Inheritance diagram for cass::pp12:
+ Collaboration diagram for cass::pp12:

Public Member Functions

 pp12 (const name_t &)
 constructor More...
 
virtual const result_tresult (const CASSEvent::id_t)
 overwrite default behaviour and just return the constant More...
 
virtual void processEvent (const CASSEvent &)
 overwrite default behaviour don't do anything More...
 
virtual void releaseEvent (const CASSEvent &)
 overwrite default behaviour don't do anything 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...
 
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...
 

Private Attributes

result_t::shared_pointer _res
 the constant result 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...
 
- Protected Member Functions inherited from cass::Processor
virtual void process (const CASSEvent &event, result_t &result)
 process the event More...
 
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 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...
 

Detailed Description

Constant Value processor.

Available PostProcessors:
"12": Constant Value
User definable Parameters:

Processor/%name%/{Value}
The value of the processors 0d result Default is 0.

Processor/%name%/{ValueType}
The type of constant that will we returned. Default is '0D'. Possible values are:

  • '0D': A 0d result will be returned
  • '1D': A 1d array result will be returned
  • '2D': A 2d image result will be returned

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
Optional settings, needed when selected 1D or 2D as type

Author
Lutz Foucar

Definition at line 301 of file operations.h.

Constructor & Destructor Documentation

pp12::pp12 ( const name_t name)

constructor

Definition at line 391 of file operations.cpp.

References loadSettings().

Member Function Documentation

void pp12::loadSettings ( size_t  )
virtual
virtual void cass::pp12::processEvent ( const CASSEvent )
inlinevirtual

overwrite default behaviour don't do anything

Reimplemented from cass::Processor.

Definition at line 314 of file operations.h.

virtual void cass::pp12::releaseEvent ( const CASSEvent )
inlinevirtual

overwrite default behaviour don't do anything

Reimplemented from cass::Processor.

Definition at line 317 of file operations.h.

virtual const result_t& cass::pp12::result ( const CASSEvent::id_t  )
inlinevirtual

overwrite default behaviour and just return the constant

Reimplemented from cass::Processor.

Definition at line 308 of file operations.h.

References _res.

Member Data Documentation

result_t::shared_pointer cass::pp12::_res
private

the constant result

Definition at line 324 of file operations.h.

Referenced by loadSettings(), and result().


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