EA::Filter Class Reference

Filter class. More...

#include <Filter.h>

Inheritance diagram for EA::Filter:

Classes
class	Representation

Public Member Functions
	Filter ()
	Constructor. More...
FilterResult	GetFilterResult ()
	Get the result for the filter. More...
FilterLogic	GetFilterLogic ()
	Get the current filter logic. More...
void	SetFilterStatus (FilterStatus status)
	Toggles on and off filtering. More...
FilterStatus	GetFilterStatus ()
	The filter status. More...
void	SetFilterLogic (FilterLogic filterLogic)
	Sets the filter return value logic. More...

Protected Member Functions
void	SetFilterResult (FilterResult result)
	Sets the result. More...
	Filter (const std::shared_ptr< Representation > &impl)
std::shared_ptr< Representation > &	GetRepresentation ()

Private Attributes
std::shared_ptr< Representation >	_repr

Detailed Description

Filter class.

The class implements a filter with an internal result flag (determined by the outcome of a selection routine) and accessory methods for enabling/disabling the filter and for inverting the filter logic.

Constructor & Destructor Documentation

Filter() [1/2]

EA::Filter::Filter

(

)

Constructor.

Filter() [2/2]

EA::Filter::Filter ( const std::shared_ptr< Representation > &  impl )

inlineprotected

Member Function Documentation

GetFilterLogic()

FilterLogic EA::Filter::GetFilterLogic ( )

inline

Get the current filter logic.

Returns

DIRECT or INVERSE.

GetFilterResult()

FilterResult EA::Filter::GetFilterResult

(

)

Get the result for the filter.

This routine checks the filter internal result and returns PASS or FALSE according to the filter logic.

Returns

PASS if the internal filter result is PASS the filter logic is DIRECT, or if if the internal filter result is REJECT and the filter logic is INVERSE, or if the filter status is DISABLED.

See also

SetFilterStatus, SetFilterLogic

GetFilterStatus()

FilterStatus EA::Filter::GetFilterStatus ( )

inline

The filter status.

This method returns the status of the filter for the algorithm.

Returns

ENABLED or DISABLED

See also

SetFilterStatus

GetRepresentation()

std::shared_ptr<Representation>& EA::Filter::GetRepresentation ( )

inlineprotected

SetFilterLogic()

void EA::Filter::SetFilterLogic

(

FilterLogic

filterLogic

)

Sets the filter return value logic.

If INVERSE logic is set, then GetFilterResult return value will be inverted, e.g., it will return PASS when the internal filter result is REJECT and vice-versa.

Parameters

filterLogic

If INVERSE then the filter logic will be inverted.

SetFilterResult()

void EA::Filter::SetFilterResult ( FilterResult  result )

inlineprotected

Sets the result.

This method sets the result flag for the filter. This value will be combined with the filter logic in order to obtain the return value of GetFilterResult.

Parameters

result

PASS or REJECT.

See also

GetFilterResult, SetFilterLogic

SetFilterStatus()

void EA::Filter::SetFilterStatus

(

FilterStatus

status

)

Toggles on and off filtering.

By disabling the filter the result of GetFilterResult will always be PASS, regardless of the internal filter result.

Parameters

status

If DISABLED, filtering will be disabled.

Member Data Documentation

_repr

std::shared_ptr<Representation> EA::Filter::_repr

private

---

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

• /builds/mori/EventAnalysis/include/core/Filter.h
• /builds/mori/EventAnalysis/src/core/Filter.cpp