MGD::IMAGEFILEWRITER::SETTINGS Class Reference

Container for settings specifying format and compression. More...

#include <mi32/mg2imagefilewriter.h>

List of all members.

Classes
class	FORM
Public Types
enum	COMPRESSTYPE {   COMPRESSTYPE_None = 0, COMPRESSTYPE_DPCM = 2, COMPRESSTYPE_Huffman = 3, COMPRESSTYPE_LZW = 4,   COMPRESSTYPE_PackBits = 5, COMPRESSTYPE_JPEG_BestQuality = 6, COMPRESSTYPE_JPEG_UserQuality = 7, COMPRESSTYPE_JPEG2000_Lossless = 8,   COMPRESSTYPE_JPEG2000_BestQuality = 9, COMPRESSTYPE_JPEG2000_UserRatio = 10 }
enum	FORMAT {   FORMAT_RVC = 0x00000100, FORMAT_GeoJP2 = 0x00000200, FORMAT_JP2 = 0x00000400, FORMAT_GeoTIFF = 0x00000800,   FORMAT_TIFF = 0x00001000, FORMAT_JPEG = 0x00002000, FORMAT_PNG = 0x00004000, FORMAT_MASK = 0xFFFFFF00 }
Public Member Functions
	SETTINGS ()
UINT16	GetCompressQuality () const
UINT16	GetCompressRatio () const
COMPRESSTYPE	GetCompressType () const
const char *	GetFileExtension () const
FORMAT	GetFormat () const
bool	IniRead (void *IniHandle, const char *group, const char *field)
void	IniWrite (void *IniHandle, const char *group, const char *field) const

---

Detailed Description

Container for settings specifying format and compression.

---

Member Enumeration Documentation

enum MGD::IMAGEFILEWRITER::SETTINGS::COMPRESSTYPE

Compression type enumeration.

Enumerator:

COMPRESSTYPE_None
COMPRESSTYPE_DPCM
COMPRESSTYPE_Huffman
COMPRESSTYPE_LZW
COMPRESSTYPE_PackBits
COMPRESSTYPE_JPEG_BestQuality
COMPRESSTYPE_JPEG_UserQuality
COMPRESSTYPE_JPEG2000_Lossless
COMPRESSTYPE_JPEG2000_BestQuality
COMPRESSTYPE_JPEG2000_UserRatio

enum MGD::IMAGEFILEWRITER::SETTINGS::FORMAT

Image file format.

Enumerator:

FORMAT_RVC
FORMAT_GeoJP2
FORMAT_JP2
FORMAT_GeoTIFF
FORMAT_TIFF
FORMAT_JPEG
FORMAT_PNG
FORMAT_MASK

---

Constructor & Destructor Documentation

MGD::IMAGEFILEWRITER::SETTINGS::SETTINGS

(

)

Default constructor.

Initializes to RVC uncompressed.

---

Member Function Documentation

UINT16 MGD::IMAGEFILEWRITER::SETTINGS::GetCompressQuality

(

)

const [inline]

Get compression quality.

Returns:

compression quality, 100 for best. Applies to JPEG compression types.

UINT16 MGD::IMAGEFILEWRITER::SETTINGS::GetCompressRatio

(

)

const [inline]

Get compression ratio.

Returns:

compression ratio, 0 for lossless, 1 for best quality, > 1 for specified ratio Applies to JPEG2000 compression types.

COMPRESSTYPE MGD::IMAGEFILEWRITER::SETTINGS::GetCompressType

(

)

const [inline]

Get compression types.

const char* MGD::IMAGEFILEWRITER::SETTINGS::GetFileExtension

(

)

const

Get file extension based on current format.

Returns:

Extension with no "." (eg "tif").

FORMAT MGD::IMAGEFILEWRITER::SETTINGS::GetFormat

(

)

const [inline]

Get format.

bool MGD::IMAGEFILEWRITER::SETTINGS::IniRead	(	void *	IniHandle,
		const char *	group,
		const char *	field
	)

Read settings from INI file.

Returns:

'true' if the entry exists.

Parameters:

	IniHandle	Handle to INI file to read from, 0 for default file
	group	INI group to read from
	field	INI field to read from

void MGD::IMAGEFILEWRITER::SETTINGS::IniWrite	(	void *	IniHandle,
		const char *	group,
		const char *	field
	)			const

Write settings to INI file.

Parameters:

	IniHandle	Handle to INI file to write to, 0 for default file
	group	INI group to write to
	field	INI field to write to

---

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

• mi32/mg2imagefilewriter.h