RSB  0.9.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::filter::ScopeFilter Class Reference

#include <ScopeFilter.h>

Inheritance diagram for rsb::filter::ScopeFilter:
Inheritance graph
Collaboration diagram for rsb::filter::ScopeFilter:
Collaboration graph

Public Member Functions

 ScopeFilter (const Scope &scope)
 
virtual ~ScopeFilter ()
 
std::string getClassName () const
 
void printContents (std::ostream &stream) const
 
bool match (EventPtr e)
 Matches the given event against the constraints specified by this filter. More...
 
Scope getScope ()
 
void notifyObserver (FilterObserverPtr fo, FilterAction::Types at)
 Double-dispatch method to notfify a FilterObserver about changes for this filter with a more specific type that the general Filter interface. More...
 
- Public Member Functions inherited from rsb::filter::Filter
 Filter ()
 
virtual ~Filter ()
 

Private Attributes

Scope scope
 

Detailed Description

Author
swrede

Definition at line 39 of file ScopeFilter.h.

Constructor & Destructor Documentation

rsb::filter::ScopeFilter::ScopeFilter ( const Scope scope)

Definition at line 35 of file ScopeFilter.cpp.

rsb::filter::ScopeFilter::~ScopeFilter ( )
virtual

Definition at line 39 of file ScopeFilter.cpp.

Member Function Documentation

string rsb::filter::ScopeFilter::getClassName ( ) const

Definition at line 42 of file ScopeFilter.cpp.

Scope rsb::filter::ScopeFilter::getScope ( )

Definition at line 63 of file ScopeFilter.cpp.

References scope.

bool rsb::filter::ScopeFilter::match ( EventPtr  e)
virtual

Matches the given event against the constraints specified by this filter.

Parameters
ethe event to match. Must not be changed!
Returns
true if the event matches the restrictions specified by this filter and hence can be delivered to the client, false to remove the event from the stream.

Implements rsb::filter::Filter.

Definition at line 50 of file ScopeFilter.cpp.

References scope.

void rsb::filter::ScopeFilter::notifyObserver ( FilterObserverPtr  fo,
FilterAction::Types  at 
)
virtual

Double-dispatch method to notfify a FilterObserver about changes for this filter with a more specific type that the general Filter interface.

The default implementation does not generate a specific notification on FilterObserver. Override this method if there is a specific reception method in FilterObserver.

Parameters
fothe observer to notify
ataction that is performed with this filter. Just pass this to the observer

Reimplemented from rsb::filter::Filter.

Definition at line 59 of file ScopeFilter.cpp.

void rsb::filter::ScopeFilter::printContents ( std::ostream &  stream) const

Definition at line 46 of file ScopeFilter.cpp.

References scope.

Member Data Documentation

Scope rsb::filter::ScopeFilter::scope
private

Definition at line 54 of file ScopeFilter.h.

Referenced by getScope(), match(), and printContents().


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