fsf::CFilter Class Reference
[Filters]

Base filter class. More...

#include <FsfFilter.h>

Inherited by fsf::CActiveFilterBase, and fsf::CPassiveFilterBase.

List of all members.

Public Member Functions

Creators
 CFilter ()
 0-parameter constructor
 CFilter (const std::string &strName, long nFilterID=-1, bool bOptional=false)
 3-parameter constructor: target name, filter ID, optional flag
 CFilter (const CFilter &f)
 Copy constructor.
virtual ~CFilter ()
 Virtual destructor.
Accessors
void getName (std::string &strName) const
 Gets this filter's target name value.
long getFilterID () const
 Gets the filter ID.
bool isOptional () const
 Gets the optional status of this filter.
Manipulators
void setName (const std::string &strName)
 Sets this filter's target name.
void setFilterID (long nFilterID)
 Sets this filter's unique ID.
bool setOptional (bool bOptional=true)
 Sets the optional status of this filter.

Protected Member Functions

Manipulators
Non thread safe protected access to private data member

const std::string & getName () const
 Gets name string.
bool hasWildcard () const
 Returns true if name has widlcard.


Detailed Description

Base filter class.

A filter contains a node signature pattern, i.e. a pointer to a node template (type) and a node name that can include wildcards. A filter can also have children filters to form a hierarchical structure isomorphic to that of the target. A filter can be marked as optional, in which case filtering will not fail if a correponding target node is not found. It can also be given a numerical ID that will be transmitted to the generated handles during filtering. Distinct active and passive filter types are derived from this base class, as they are semantically different and implement specific filtering algorithms.


Constructor & Destructor Documentation

fsf::CFilter::CFilter (  )  [inline]

0-parameter constructor

fsf::CFilter::CFilter ( const std::string &  strName,
long  nFilterID = -1,
bool  bOptional = false 
) [inline]

3-parameter constructor: target name, filter ID, optional flag

CFilter::CFilter ( const CFilter f  ) 

Copy constructor.

virtual fsf::CFilter::~CFilter (  )  [inline, virtual]

Virtual destructor.


Member Function Documentation

long fsf::CFilter::getFilterID (  )  const [inline]

Gets the filter ID.

void fsf::CFilter::getName ( std::string &  strName  )  const [inline]

Gets this filter's target name value.

const std::string& fsf::CFilter::getName (  )  const [inline, protected]

Gets name string.

bool fsf::CFilter::hasWildcard (  )  const [inline, protected]

Returns true if name has widlcard.

bool fsf::CFilter::isOptional (  )  const [inline]

Gets the optional status of this filter.

void fsf::CFilter::setFilterID ( long  nFilterID  )  [inline]

Sets this filter's unique ID.

void fsf::CFilter::setName ( const std::string &  strName  )  [inline]

Sets this filter's target name.

bool fsf::CFilter::setOptional ( bool  bOptional = true  )  [inline]

Sets the optional status of this filter.


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

Generated on Thu Oct 21 11:47:37 2010 for MFSM by  doxygen 1.5.9