API  4.1
For C++ developers
OpenSim::ComponentFilter Class Referenceabstract

A class to specify a filter to be used to iterate through components. More...

+ Inheritance diagram for OpenSim::ComponentFilter:

Public Member Functions

virtual ~ComponentFilter ()
 Destructor of ComponentFilter, does nothing. More...
 
virtual bool isMatch (const Component &comp) const =0
 This is the meat of the ComponentFilter, returns false if the passed in component should be skipped over. More...
 
virtual ComponentFilterclone () const =0
 clone() method needed to make a copy of the filter. More...
 

Protected Member Functions

 ComponentFilter ()
 Default constructor of ComponentFilter, does nothing. More...
 

Detailed Description

A class to specify a filter to be used to iterate through components.

More flexible than filtering based on Type only. To write your custom filter, extend this class and implement the isMatch() and clone() methods.

Constructor & Destructor Documentation

◆ ComponentFilter()

OpenSim::ComponentFilter::ComponentFilter ( )
inlineprotected

Default constructor of ComponentFilter, does nothing.

For use by derived classes only.

◆ ~ComponentFilter()

virtual OpenSim::ComponentFilter::~ComponentFilter ( )
inlinevirtual

Destructor of ComponentFilter, does nothing.

References clone(), and isMatch().

Member Function Documentation

◆ clone()

virtual ComponentFilter* OpenSim::ComponentFilter::clone ( ) const
pure virtual

clone() method needed to make a copy of the filter.

Implemented in OpenSim::ComponentFilterAbsolutePathNameContainsString, and OpenSim::ComponentFilterMatchAll.

Referenced by ~ComponentFilter().

◆ isMatch()

virtual bool OpenSim::ComponentFilter::isMatch ( const Component comp) const
pure virtual

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