FrameFilterImpl::addBoolParam Method

Registers a boolean parameter than can be accessed using the methods of IFrameFilter.
Syntax:
protected:
     void addBoolParam( const std::string& name, tFilterError (T::*getFunc)( bool& ), tFilterError (T::*setFunc)( bool ) );
     void addBoolParam( const std::wstring& name, tFilterError (T::*getFunc)( bool& ), tFilterError (T::*setFunc)( bool ) );

Name Description
name

Name of the parameter. This string has to be passed to IFrameFilter::setParameter or IFrameFilter::getParameter to access the parameter.

getFunc

Name of a member function of the class derived from FrameFilterImpl. Has to take a reference to a bool as it only parameter and return a tFilterError.

setFunc

Name of a member function of the class derived from FrameFilterImpl. Has to take a bool as its only parameter and return a tFilterError.

Remarks:

You should register all parameters of your frame filter in your constructor.

Example:

For an example how to register a parameter, see addFloatParam.

See also: FrameFilterImpl, FrameFilterImpl::addLongParam, FrameFilterImpl::addFloatParam, FrameFilterImpl::addStringParam, FrameFilterImpl::addDataParam

<< FrameFilterImpl