SPATMOD::IMAGE::TARGET_BIL Class Reference

General band-interleaved (BIL) file target. More...

#include <spatmod/imagetargetbil.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_BIL:

[legend]

List of all members.

Public Member Functions
	TARGET_BIL (STAGE *pInputStage, const FILEPATH &filepath)
virtual	~TARGET_BIL ()
const FILEPATH &	GetFilePath () const
void	SetBandSpacingBytes (UINT32 BandSpacingBytes)
void	SetFileHeaderBytes (UINT32 FileHeaderBytes)
void	SetFileTrailerBytes (UINT32 FileTrailerBytes)
void	SetRowSpacingBytes (UINT32 RowSpacingBytes)
Protected Member Functions
FILE_RAW &	GetFile ()
FILEPATH &	GetFilePath ()
virtual ERRVALUE	v_Initialize ()
virtual ERRVALUE	v_PushBegin (const SECTION_ITERATOR &iterator)
virtual ERRVALUE	v_PushEnd ()
virtual ERRVALUE	v_PushSubSection (const SECTION &SubSection, const BUFFER &buffer)

---

Detailed Description

General band-interleaved (BIL) file target.

Can be derived from to include additional headers/trailers. Supports writing non-sequentially and adding to existing file.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::TARGET_BIL::TARGET_BIL	(	STAGE *	pInputStage,
		const FILEPATH &	filepath
	)

Construct with specified input stage and path to target file.

Target does not take ownership of input stage.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	filepath	Path to target file

virtual SPATMOD::IMAGE::TARGET_BIL::~TARGET_BIL

(

)

[virtual]

Destructor.

---

Member Function Documentation

FILE_RAW& SPATMOD::IMAGE::TARGET_BIL::GetFile

(

)

[inline, protected]

Get file.

FILEPATH& SPATMOD::IMAGE::TARGET_BIL::GetFilePath

(

)

[inline, protected]

Get (non-const) path to output file.

const FILEPATH& SPATMOD::IMAGE::TARGET_BIL::GetFilePath

(

)

const [inline]

Get path to output file.

void SPATMOD::IMAGE::TARGET_BIL::SetBandSpacingBytes

(

UINT32

BandSpacingBytes

)

[inline]

Set band spacing bytes.

Contents of file data is undefined, override v_PushSubSection to write. Must be done before Initialize.

Parameters:

BandSpacingBytes

Spacing between each band within row

void SPATMOD::IMAGE::TARGET_BIL::SetFileHeaderBytes

(

UINT32

FileHeaderBytes

)

[inline]

Set file header bytes.

Contents of file data is undefined, override v_PushBegin to write. Must be done before Initialize.

Parameters:

FileHeaderBytes

Spacing before first row in file

void SPATMOD::IMAGE::TARGET_BIL::SetFileTrailerBytes

(

UINT32

FileTrailerBytes

)

[inline]

Set file trailer bytes.

Contents of file data is undefined, override v_PushEnd to write. Must be done before Initialize.

Parameters:

FileTrailerBytes

Spacing after last row in file

void SPATMOD::IMAGE::TARGET_BIL::SetRowSpacingBytes

(

UINT32

RowSpacingBytes

)

[inline]

Set row spacing bytes.

Contents of file data is undefined, override v_PushSubSection to write. Must be done before Initialize.

Parameters:

RowSpacingBytes

Spacing between rows in file

virtual ERRVALUE SPATMOD::IMAGE::TARGET_BIL::v_Initialize

(

)

[protected, virtual]

Initialize target, does not create file.

Implements SPATMOD::IMAGE::TARGET.

virtual ERRVALUE SPATMOD::IMAGE::TARGET_BIL::v_PushBegin

(

const SECTION_ITERATOR &

iterator

)

[protected, virtual]

If override, must call base method to create file.

File will be resized to accommodate entire image including header, spacing and trailer. Initial file contents are undefined.

Implements SPATMOD::IMAGE::TARGET.

virtual ERRVALUE SPATMOD::IMAGE::TARGET_BIL::v_PushEnd

(

)

[protected, virtual]

Closes output file.

Implements SPATMOD::IMAGE::TARGET.

virtual ERRVALUE SPATMOD::IMAGE::TARGET_BIL::v_PushSubSection	(	const SECTION &	SubSection,
		const BUFFER &	buffer
	)			[protected, virtual]

If override, must call base method to write data.

Implements SPATMOD::IMAGE::TARGET.

---

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

• spatmod/imagetargetbil.h