SPATMOD::IMAGE::FORMAT Class Reference

Container for image format specification and file extension. More...

#include <spatmod/imageformat.h>

List of all members.

Public Types
enum	SPEC {   SPEC_Undefined, SPEC_JPEG, SPEC_PNG, SPEC_TIFF,   SPEC_JP2, SPEC_GIF, SPEC_SVG, SPEC_SVGZ,   SPEC_DAE, SPEC_PNG16, SPEC_PNG16A, SPEC_PNG16OLD,   SPEC_PNG24, SPEC_PNG32, SPEC_KML }
Public Member Functions
	FORMAT (const FORMAT &rhs)
	FORMAT (const char *str, const char *FileExtn=0)
	FORMAT (const FACTORY_TARGET_FILE &FactoryTgt, const char *FileExtn=0)
	FORMAT (FORMAT::SPEC spec, const char *FileExtn=0)
	FORMAT ()
	~FORMAT ()
const FACTORY_TARGET_FILE *	GetFactoryTgt () const
const char *	GetFileExtn () const
const char *	GetMimeType () const
SPEC	GetSpec () const
FORMAT &	operator= (const FORMAT &rhs)

---

Detailed Description

Container for image format specification and file extension.

---

Member Enumeration Documentation

enum SPATMOD::IMAGE::FORMAT::SPEC

Enumeration for common format specifications.

Each generally corresponds to a specific set of file extensions and SOURCE/TARGET pair.

Enumerator:

SPEC_Undefined
SPEC_JPEG
SPEC_PNG
SPEC_TIFF
SPEC_JP2
SPEC_GIF
SPEC_SVG
SPEC_SVGZ
SPEC_DAE
SPEC_PNG16
SPEC_PNG16A
SPEC_PNG16OLD
SPEC_PNG24
SPEC_PNG32
SPEC_KML

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::FORMAT::FORMAT

(

)

Default constructor for undefined specification.

SPATMOD::IMAGE::FORMAT::FORMAT	(	FORMAT::SPEC	spec,
		const char *	FileExtn = 0
	)

Construct with given specification.

Parameters:

FileExtn

Optional file extension, will use default 3-character extension if 0

SPATMOD::IMAGE::FORMAT::FORMAT	(	const FACTORY_TARGET_FILE &	FactoryTgt,
		const char *	FileExtn = 0
	)

Construct with TARGET_FILE::FACTORY.

Parameters:

FileExtn

Optional file extension, will use default 3-character extension if 0

SPATMOD::IMAGE::FORMAT::FORMAT	(	const char *	str,
		const char *	FileExtn = 0
	)

Construct from string.

Parameters:

	str	String in MIME format (eg "image/jpeg");
	FileExtn	Optional file extension, will use default 3-character extension if 0

SPATMOD::IMAGE::FORMAT::FORMAT

(

const FORMAT &

rhs

)

Copy constructor.

SPATMOD::IMAGE::FORMAT::~FORMAT

(

)

Destructor.

---

Member Function Documentation

const FACTORY_TARGET_FILE* SPATMOD::IMAGE::FORMAT::GetFactoryTgt

(

)

const [inline]

Get factory for constructing TARGET_FILE instance if defined.

Returns:

NULL if no factory set.

const char* SPATMOD::IMAGE::FORMAT::GetFileExtn

(

)

const

Get file extension specified when constructed or default if none specified.

const char* SPATMOD::IMAGE::FORMAT::GetMimeType

(

)

const

Get MIME type string (eg "image/jpeg") for specification.

Returns:

0 if none defined.

SPEC SPATMOD::IMAGE::FORMAT::GetSpec

(

)

const [inline]

Get specification enumeration.

FORMAT& SPATMOD::IMAGE::FORMAT::operator=

(

const FORMAT &

rhs

)

Assignment.

---

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

• spatmod/imageformat.h