basic filter More...

#include <ZFFilter.h>

Inheritance diagram for ZFFilterBasic< T_Public, T_Internal >:

Public Member Functions
	ZFFilterBasic (void)
	see ZFFilterBasic

	ZFFilterBasic (const ZFFilterBasic< T_Public, T_Internal > &ref)
	see ZFFilterBasic

Public Member Functions inherited from ZFFilterBase< T_Public, T_Public >
	ZFFilterBase (void)
	main constructor

	ZFFilterBase (const ZFFilterBase< T_Public, T_Public > &ref)
	construct from another filter, retain only, you should use copyFrom to copy contents

virtual ZFFilterBase< T_Public, T_Public > &	operator= (const ZFFilterBase< T_Public, T_Public > &ref)
	retain only

virtual void	copyFrom (ZFFilterBase< T_Public, T_Public > const &ref)
	copy from another filter

virtual ZFFilterBase< T_Public, T_Public > &	filter (T_Public const &e, ZFFilterType filterType=ZFFilterTypeExclude)
	add a element

virtual ZFFilterBase< T_Public, T_Public > &	filterRemove (T_Public const &e, ZFFilterType filterType=ZFFilterTypeExclude)
	remove a element

virtual ZFFilterBase< T_Public, T_Public > &	filterRemoveAt (zfindex index)
	remove a element

virtual void	filterRemoveAll (void)
	remove all contents of this filter

virtual zfindex	filterCount (void) const
	get count of element

virtual T_Public	filterElementAt (zfindex index) const
	get element at index

virtual T_Public const &	filterInternalAt (zfindex index) const
	get filter data at index

virtual ZFFilterType	filterTypeAt (zfindex index) const
	get filter type for filter data at index

virtual ZFFilterBase< T_Public, T_Public > &	customFilterCallbackAdd (typename ZFFilterBase< T_Public, T_Public >::CustomFilterCallback customFilterCallback)
	add a custom filter callback

virtual ZFFilterBase< T_Public, T_Public > &	customFilterCallbackRemove (typename ZFFilterBase< T_Public, T_Public >::CustomFilterCallback customFilterCallback)
	remove custom filter callback

virtual ZFFilterBase< T_Public, T_Public > &	customFilterCallbackRemove (zfindex index)
	remove custom filter callback

virtual zfindex	customFilterCallbackCount (void) const
	get custom filter callback count

virtual ZFFilterBase< T_Public, T_Public >::CustomFilterCallback	customFilterCallbackAt (zfindex index) const
	get custom filter callback

virtual zfbool	filterPassed (T_Public const &e) const
	return true if e is not filtered by this filter, see ZFFilterType

virtual void	objectInfoT (zfstring &ret) const
	see objectInfo

virtual zfstring	objectInfo (void) const
	return object info

Protected Types
typedef ZFFilterBase< T_Public, T_Internal >	zfsuper
	class ref to super

typedef ZFFilterBasic< T_Public, T_Internal >	zfself
	class ref to self

Protected Types inherited from ZFFilterBase< T_Public, T_Public >
typedef ZFFilterBase< T_Public, T_Public >	zfself
	typedef for self

Additional Inherited Members
Public Types inherited from ZFFilterBase< T_Public, T_Public >
typedef ZFFilterResult(*	CustomFilterCallback) (T_Public const &e)
	custom filter callback for ZFFilter

Protected Member Functions inherited from ZFFilterBase< T_Public, T_Public >
virtual zfbool	filterOnCheckValid (T_Public const &e) const
	return true if element is valid for a filter

virtual void	filterOnStore (T_Public &to, T_Public const &from) const=0
	store public type to internal storage type

virtual void	filterOnRemove (T_Public &value) const
	called before value removed from filter

virtual void	filterOnAccess (T_Public &to, T_Public const &from) const=0
	access public type from internal storage type

virtual zfbool	filterOnCheckEqual (T_Public const &e1, T_Public const &e2) const=0
	true if e1 is regarded as equal to e2

virtual zfbool	filterOnCheckActive (T_Public const &e) const
	called by filterPassed to check whether the element is filtered out

Detailed Description

template<typename T_Public, typename T_Internal = T_Public>
class ZFFilterBasic< T_Public, T_Internal >

basic filter

a basic filter is:

support operator = to assign value between public type and internal storage type
support operator == to compare whether public type is equal to internal storage type

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

ZFFilter.h

ZFFramework

Public Member Functions

Protected Types

Additional Inherited Members

Detailed Description