BMM_IOHandler Class Reference

#include <bitmap.h>

Inheritance diagram for BMM_IOHandler:

Public Member Functions
BMMExport	BMM_IOHandler ()
BMMExport const MCHAR *	ShortDescription (const MCHAR *d=nullptr)
BMMExport const MCHAR *	LongDescription (const MCHAR *d=nullptr)
BMMExport const MCHAR *	Extension (int index, const MCHAR *e=nullptr)
BMMExport int	NumExtensions () const
BMMExport void	SetCD (ClassDesc *dll)
	This grabs the ClassID and the SuperClassID of Class Descriptor that gets passed in.
BMMExport ClassDesc *	GetCD ()
BMMExport Class_ID	GetClassID () const
BMMExport SClass_ID	GetSuperID () const
BMMExport void	SetDllNumber (int num)
BMMExport int	GetDllNum () const
BMMExport void	SetCapabilities (DWORD cap)
BMMExport DWORD	GetCapabilities () const
BMMExport BOOL	TestCapabilities (DWORD cap) const
BMMExport BMM_IOHandler &	operator= (const BMM_IOHandler &from)

Additional Inherited Members
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class BMM_IOList.

Description:

This class provides methods that access properties of the IO module. All methods of this class are implemented by the system.

Constructor & Destructor Documentation

BMM_IOHandler()

BMMExport BMM_IOHandler

(

)

Remarks

Constructor. The description string is set to NULL, the capabilities are set to NONE, and the Class Descriptor is set to NULL.

Member Function Documentation

ShortDescription()

BMMExport const MCHAR * ShortDescription

(

const MCHAR *

d = nullptr

)

Remarks

Returns the short description string for the IO module, and optionally sets it to d if it is not NULL.

Parameters:

const MCHAR *d = NULL

The short description string to set.

LongDescription()

BMMExport const MCHAR * LongDescription

(

const MCHAR *

d = nullptr

)

Remarks

Returns the long description string for the IO module, and optionally sets it to d if it is not NULL.

Parameters:

const MCHAR *d = NULL

The long description string to set.

Extension()

BMMExport const MCHAR * Extension	(	int	index,
		const MCHAR *	e = nullptr
	)

Remarks

Returns the specified IO module file name extension, and optionally sets it to e if it is not NULL.

Parameters:

int index

The index of the extension.

const MCHAR *e = NULL

The extension string.

NumExtensions()

BMMExport int NumExtensions ( ) const

inline

Remarks

Returns the number of file name extensions for the IO module.

{ return ioExtension.Count(); }

SetCD()

BMMExport void SetCD

(

ClassDesc *

dll

)

This grabs the ClassID and the SuperClassID of Class Descriptor that gets passed in.

It does not grab a hold of the Class Descriptor pointer itself.

Parameters

dll	- A pointer to the class descriptor.

GetCD()

BMMExport ClassDesc * GetCD

(

)

Remarks

Returns the class descriptor for the IO module.

GetClassID()

BMMExport Class_ID GetClassID

(

)

const

GetSuperID()

BMMExport SClass_ID GetSuperID

(

)

const

SetDllNumber()

BMMExport void SetDllNumber ( int  num )

inline

{ dllNumber = num; }

GetDllNum()

BMMExport int GetDllNum ( ) const

inline

{ return dllNumber; }

SetCapabilities()

BMMExport void SetCapabilities ( DWORD  cap )

inline

Remarks

Sets the capabilities flag for the IO module.

Parameters:

DWORD cap

See BitmapIO Capability Flags

{ ioCapabilities |= cap; }

GetCapabilities()

BMMExport DWORD GetCapabilities ( ) const

inline

Remarks

Returns the capabilities flag for the IO module.

Returns

See BitmapIO Capability Flags

{ return ioCapabilities; }

TestCapabilities()

BMMExport BOOL TestCapabilities ( DWORD  cap ) const

inline

Remarks

Tests the capability flags passed.

Parameters:

DWORD cap

See BitmapIO Capability Flags.

Returns

TRUE if the flags were set; otherwise FALSE.

Operators:

{ return (ioCapabilities & cap) != 0; }

operator=()

BMMExport BMM_IOHandler & operator=

(

const BMM_IOHandler &

from

)

Remarks

Assignment operator.