SPATMOD::IMAGE::SOURCE_FILE Class Reference

Base for "file" source. More...

#include <spatmod/imagesourcefile.h>

Inheritance diagram for SPATMOD::IMAGE::SOURCE_FILE:

[legend]

List of all members.

Public Member Functions
const FILEPATH &	GetFilePath () const
const SIMPLE_ARRAY< UINT8 > &	GetMemBuffer () const
bool	ReadGeoreference ()
Protected Member Functions
	SOURCE_FILE (UINT8 *&MemBuffer, UINT32 BufferSize)
	SOURCE_FILE (SIMPLE_ARRAY< UINT8 > &MemBuffer)
	SOURCE_FILE (const FILEPATH &FilePath)
virtual	~SOURCE_FILE ()
SIMPLE_ARRAY< UINT8 > &	GetMemBuffer ()
ERRVALUE	SaveMemBufferToTempFile (const char *extn="tmp")

---

Detailed Description

Base for "file" source.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SOURCE_FILE::SOURCE_FILE

(

const FILEPATH &

FilePath

)

[explicit, protected]

Construct with FILEPATH.

SPATMOD::IMAGE::SOURCE_FILE::SOURCE_FILE

(

SIMPLE_ARRAY< UINT8 > &

MemBuffer

)

[explicit, protected]

Construct with memory buffer (SIMPLE_ARRAY).

Will take ownership of buffer.

Parameters:

MemBuffer

Memory buffer, will be returned empty

SPATMOD::IMAGE::SOURCE_FILE::SOURCE_FILE	(	UINT8 *&	MemBuffer,
		UINT32	BufferSize
	)			[protected]

Construct with memory buffer (pointer/size).

Will take ownership of buffer, pointer will be returned as NULL

Parameters:

	MemBuffer	Memory buffer, will be returned as NULL
	BufferSize	Buffer size

virtual SPATMOD::IMAGE::SOURCE_FILE::~SOURCE_FILE

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

const FILEPATH& SPATMOD::IMAGE::SOURCE_FILE::GetFilePath

(

)

const [inline]

Get file path.

SIMPLE_ARRAY<UINT8>& SPATMOD::IMAGE::SOURCE_FILE::GetMemBuffer

(

)

[inline, protected]

Get reference to memory buffer.

Should avoid changing buffer, method is to support 3rd-party implementation not accepting const buffer.

const SIMPLE_ARRAY<UINT8>& SPATMOD::IMAGE::SOURCE_FILE::GetMemBuffer

(

)

const [inline]

Get (const) reference to memory buffer.

bool SPATMOD::IMAGE::SOURCE_FILE::ReadGeoreference

(

)

Attempt to locate and read georeference based on file path.

Returns:

True if successful, false if not.

ERRVALUE SPATMOD::IMAGE::SOURCE_FILE::SaveMemBufferToTempFile

(

const char *

extn = "tmp"

)

[protected]

Save memory buffer to temporary file, with file deletion on destruction.

This is useful for derived classes that require an actual file to read.

Parameters:

extn

File extension to use

---

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

• spatmod/imagesourcefile.h