FLT_FilterList Class Reference

#include <filters.h>

Inheritance diagram for FLT_FilterList:

Public Member Functions
	FLT_FilterList ()
BOOL	Listed (BOOL f)
BOOL	Listed ()
FLTExport int	FindFilter (const MCHAR *name)
FLTExport DWORD	GetFilterCapabilities (const MCHAR *name)
FLTExport ImageFilter *	CreateFilterInstance (const MCHAR *d)
Public Member Functions inherited from Array< FLT_FilterHandler >
	Array ()
	Initializes an empty array. More...
	Array (size_t initUsedLength, const FLT_FilterHandler &defaultVal=FLT_FilterHandler(), size_t initGrowLength=kDefaultGrowthLength)
	Initializes an array with an initial size. More...
	Array (const Array< FLT_FilterHandler > &src)
	Copy constructor. More...
	Array (InputIt begin, InputIt end)
	Copy constructor. More...
	~Array ()
	Destructor. Destroys every element stored in the array, and frees the allocated storage. More...
Array< FLT_FilterHandler > &	operator= (const Array< FLT_FilterHandler > &src)
	Copy operator. More...
bool	operator== (const Array< FLT_FilterHandler > &op) const
	Equality operator. More...
Array< FLT_FilterHandler > &	setAt (size_t index, const FLT_FilterHandler &value)
	Sets a copy of value at the given index. More...
Array< FLT_FilterHandler > &	setAll (const FLT_FilterHandler &value)
	Sets all the elements of the array to the given value. More...
bool	isValidIndex (size_t) const
	Returns whether the given array index is valid for this array. More...
FLT_FilterHandler &	operator[] (size_t i)
	Subscript operator. More...
const FLT_FilterHandler &	operator[] (size_t i) const
	Subscript operator. More...
const FLT_FilterHandler &	at (size_t index) const
	Same as subscript operator. More...
FLT_FilterHandler &	at (size_t index)
	Same as subscript operator. More...
FLT_FilterHandler &	first ()
	Accesses the first element in the array. More...
const FLT_FilterHandler &	first () const
	Accesses the first element in the array. More...
FLT_FilterHandler *	begin ()
	Accesses the begin iterator, which is a plain pointer in this case. More...
const FLT_FilterHandler *	begin () const
	Accesses the const begin iterator, which is a plain pointer in this case. More...
FLT_FilterHandler &	last ()
	Accesses the last element in the array. More...
const FLT_FilterHandler &	last () const
	Accesses the first element in the array. More...
FLT_FilterHandler *	end ()
	Accesses the end iterator (one past last valid element). Do not dereference. More...
const FLT_FilterHandler *	end () const
	Accesses the const end iterator (one past last valid element). Do not dereference. More...
size_t	append (const FLT_FilterHandler &value)
	Appends a copy of value to the array. More...
Array< FLT_FilterHandler > &	append (const FLT_FilterHandler *values, size_t count)
	Appends one or more element(s) to the array. More...
Array< FLT_FilterHandler > &	append (const Array< FLT_FilterHandler > &array)
	Appends the contents of another array to this array. More...
Array< FLT_FilterHandler > &	insertAt (size_t index, const FLT_FilterHandler &value)
	Inserts a single value, at a given location, into this array. More...
Array< FLT_FilterHandler > &	insertAt (size_t index, const FLT_FilterHandler *values, size_t count)
	Inserts a one or more value(s), at a given location, into this array. More...
Array< FLT_FilterHandler > &	removeAt (size_t index)
	Removes a single element from the array. More...
bool	remove (const FLT_FilterHandler &value, size_t start=0)
	Searches for a value in the array and, if it is found, removes it from the array. More...
Array< FLT_FilterHandler > &	removeFirst ()
	Removes the first element of the array. More...
Array< FLT_FilterHandler > &	removeLast ()
	Removes the last element of the array. More...
Array< FLT_FilterHandler > &	removeAll ()
	Removes all the elements from the array. More...
Array< FLT_FilterHandler > &	removeSubArray (size_t startIndex, size_t endIndex)
	Removes a subset of the array. More...
bool	contains (const FLT_FilterHandler &value, size_t start=0) const
	Determines if a value is stored in the array. More...
bool	find (const FLT_FilterHandler &value, size_t &foundAt, size_t start=0) const
	Searches for a value in the array. More...
size_t	find (const FLT_FilterHandler &value) const
	Searches for a value in the array. More...
size_t	findFrom (const FLT_FilterHandler &value, size_t start) const
	Searches for a value in the array, starting at a given index. More...
size_t	length () const
	Returns the number of used elements (as opposed to simply allocated/reserved) in the array. More...
bool	isEmpty () const
	Returns true if the number of used elements in the array is 0; returns false otherwise. More...
size_t	lengthUsed () const
	Returns the number of elements used (as opposed to simply allocated/reserved) in the array. More...
Array< FLT_FilterHandler > &	setLengthUsed (size_t length, const FLT_FilterHandler &defaultVal=FLT_FilterHandler())
	Sets the number of elements used (as opposed to simply allocated/reserved) in the array. More...
size_t	lengthReserved () const
	Returns the number of elements allocated/reserved (as opposed to actually used) in the array. More...
Array< FLT_FilterHandler > &	setLengthReserved (size_t length)
	Sets the number of elements allocated/reserved (as opposed to actually used) in the array. More...
void	reserve (size_t capacity)
	Alias for setLengthReserved. More...
size_t	growLength () const
	Returns the growth length of the array. More...
Array< FLT_FilterHandler > &	setGrowLength (size_t)
	Sets the growth length of the array. More...
Array< FLT_FilterHandler > &	reverse ()
	Reverses the sequence of elements in the array. More...
Array< FLT_FilterHandler > &	swap (size_t i1, size_t i2)
	Swaps two elements in this array. More...
void	sort (CompareFnc cmp)
	Sorts the elements of the array using a custom comparison function. More...
const FLT_FilterHandler *	asArrayPtr () const
	Returns the array storage as a C-style array pointer. More...
FLT_FilterHandler *	asArrayPtr ()
	Accesses the first element in the array. More...

Additional Inherited Members
Public Types inherited from Array< FLT_FilterHandler >
typedef int(__cdecl *	CompareFnc) (const void *elem1, const void *elem2)
	Type of function to pass to sort(). More...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
Protected Types inherited from Array< FLT_FilterHandler >
enum
Static Protected Member Functions inherited from Array< FLT_FilterHandler >
static size_t	quickSortPartition (FLT_FilterHandler *data, size_t first, size_t last, CompareFnc cmp)
	The partition portion of the QuickSort algorithm. More...
static void	quickSortRecursive (FLT_FilterHandler *data, size_t first, size_t last, CompareFnc cmp)
	Recursive QuickSort function used to sort the elements of the array. More...
static void	handleOutOfMemory ()
	Utility function, called when the array fails to allocate memory. More...
static FLT_FilterHandler *	ArrayAllocate (size_t len)
	Allocates an array of elements without constructing them. More...
static void	ArrayConstruct (FLT_FilterHandler *arrayBegin, size_t len, const FLT_FilterHandler &defaultVal)
	Constructs an array of elements. More...
static void	ArrayDeAllocate (FLT_FilterHandler *arrayBegin)
	De-allocates an array of elements without destructing them. More...
static void	ArrayDestruct (FLT_FilterHandler *arrayBegin, size_t len)
	Destructs an array of elements. More...
static void	ArrayCopy (FLT_FilterHandler *pCopy, size_t nMaxCount, const FLT_FilterHandler *pSource, size_t nCount)
	Copies an array of elements to an already-constructed buffer. More...
static void	ArrayCopyOverlap (FLT_FilterHandler *pCopy, size_t nMaxCount, const FLT_FilterHandler *pSource, size_t nCount)
	Copies an array of elements when the target and destination memory buffers may overlap. More...
static void	ArrayCopyConstruct (FLT_FilterHandler *pCopy, size_t nMaxCount, const FLT_FilterHandler *pSource, size_t nCount)
	Copies and array of elements to a non-constructed. More...
Protected Attributes inherited from Array< FLT_FilterHandler >
FLT_FilterHandler *	mpArray
	Pointer to the storage buffer. More...
size_t	mReservedLen
	The reserved length (in number of elements, not bytes). More...
size_t	mUsedLen
	The used length (in number of elements, not bytes). More...
size_t	mGrowLen
	The growth length. See setGrowLength(). More...

Detailed Description

See also

Class FilterHandler, Template Class Tab, ImageFilter Capability Flags

Description:

This class provides methods to access the table of image filters. Methods are provided to find the index in the table of the filter using it description string, check the capabilities of any filter in the table, and to create instances of any filters in the table. All methods of this class are implemented by the system.

Constructor & Destructor Documentation

FLT_FilterList()

FLT_FilterList ( )

inline

Remarks

Constructor. The flag that indicates the list of filters has been built is set to FALSE.

: listed(FALSE)          {    }

Member Function Documentation

Listed() [1/2]

BOOL Listed ( BOOL  f )

inline

Remarks

Sets the state to indicate the list of filter plug-ins has been built.

Parameters:

BOOL f

TRUE indicates the list has been built; FALSE indicates this list has not been built.

Returns

The state that was set is returned.

{ listed    = f; return (listed);};

Listed() [2/2]

BOOL Listed ( )

inline

Remarks

Returns TRUE if the list of filter plug-ins has been built; otherwise FALSE.

{ return    (listed);};

FindFilter()

FLTExport int FindFilter

(

const MCHAR *

name

)

Remarks

Returns the index in the filter table of the image filter whose description string is passed.

Parameters:

const MCHAR *name

The Description string of the filter to find.

Returns

If found, the index in the table is returned; otherwise -1.

GetFilterCapabilities()

FLTExport DWORD GetFilterCapabilities

(

const MCHAR *

name

)

Remarks

Returns the capability flags associated with the image filter whose description is passed.

Parameters:

const MCHAR *name

The Description string of the filter.

Returns

The capability flags. If not found, 0 is returned.

CreateFilterInstance()

FLTExport ImageFilter* CreateFilterInstance

(

const MCHAR *

d

)

Remarks

This method creates an instance of the ImageFilter class. This method will call Create() on the class descriptor. Make sure to delete this instance after use.

Parameters:

const MCHAR *d

The Description string of the filter to create.

Returns

An instance of the ImageFilter class. The developer is responsible for deleting this instance.