Filter< ReadAcc, WriteAcc > Class Template Reference

A typed version of DM::IFilter. See Filters. More...

#include "Filter.hpp"

+ Inheritance diagram for Filter< ReadAcc, WriteAcc >:

Public Member Functions

Filteroperator= (const Filter &)
 
String text () const
 The text that was passed to the constructor.
 
construction

Constructs a new filter based on text.

 Filter (const String &text=String())
 
 Filter (const char *text)
 
 Filter (const Filter &)
 
- Public Member Functions inherited from Handle< IFilter >
 Handle (const Handle &h)
 
 Handle (const Handle< T2, TS2, C2, A2 > &other)
 
 Handle (const Handle< T2, TS2, C2, A2 > &other, const use_static_cast &)
 
 Handle (const Handle< T2, TS2, C2, A2 > &other, const use_dynamic_cast &)
 
 Handle (IFilter *p)
 
Handleoperator= (const Handle &h)
 
Handleoperator= (const Handle< T2, TS2, C2, A2 > &other)
 
Handleoperator= (IFilter *p)
 
size_type id () const
 
 operator const IFilter & () const
 
 operator IFilter & ()
 
const IFilterptr () const
 
const IFilteroperator* () const
 
IFilteroperator* ()
 
const IFilteroperator-> () const
 
IFilteroperator-> ()
 
bool is_shared () const
 
unsigned int get_count () const
 
IFilterrelease ()
 
void swap (Handle &h)
 
void reset ()
 
Handle clone () const
 
bool operator== (const Handle &h) const
 
bool operator!= (const Handle &h) const
 
bool operator> (const Handle &h) const
 
bool operator< (const Handle &h) const
 
 operator unspecified_bool_type () const
 

Static Public Member Functions

static const char * help (bool)
 
static const char * syntax ()
 
static bool exportsPythonType ()
 
- Static Public Member Functions inherited from CustomOptionType< Filter< ReadAcc, WriteAcc > >
static const char * _help (bool forDoxygen)
 get general help on this type
 
static const char * _syntax ()
 get the syntax used for parsing this type
 
static bool _exportsPythonType ()
 returns true if this type is exposed to Python as a custom type, false otherwise (if it is represented as Python-string)
 

Additional Inherited Members

- Public Types inherited from Handle< IFilter >
typedef IFilter element_type
 
- Public Attributes inherited from Handle< IFilter >
const typedef IFilter *(self::* unspecified_bool_type )() const
 
- Protected Member Functions inherited from CustomOptionType< Filter< ReadAcc, WriteAcc > >
 ~CustomOptionType ()
 protected, must be derived from
 

Detailed Description

template<DM::IFilter::ReadAccess ReadAcc, DM::IFilter::WriteAccess WriteAcc>
class opals::Filter< ReadAcc, WriteAcc >

A typed version of DM::IFilter. See Filters.

Template Parameters
ReadAccread access
WriteAccwrite access

Derives from a handle for simplicity, but every object holds its own clone.

See Filters

Constructor & Destructor Documentation

◆ Filter()

Filter ( const String text = String())

If text is empty or "pass", results in an empty base handle.