SPATMOD::IMAGE::TARGET_TILESET_FILE Class Reference

Target base class for outputting tileset as files. More...

#include <spatmod/imagetargettilesetfile.h>

Inheritance diagram for SPATMOD::IMAGE::TARGET_TILESET_FILE:

[legend]

Public Member Functions
virtual	~TARGET_TILESET_FILE ()
ERRVALUE	CreateCatalogExcludeFile ()
bool	GetCreateAdditionalFiles () const
bool	GetDeleteAfterZip () const
bool	GetMakeTileMap () const
double	GetPixelValueMax () const
double	GetPixelValueMin () const
INT64	GetPostscaleOffset () const
INT64	GetPrescaleOffset () const
double	GetScale () const
INT32	GetScaleDenominator () const
INT32	GetScaleNumerator () const
const FILEPATH &	GetTileFolderBasePath () const
bool	GetUsePalette () const
bool	GetZipOutput () const
void	SetCreateAdditionalFiles (bool CreateAdditionalFiles)
void	SetMakeTileMap (bool MakeTileMap)
void	SetPixelValueRange (double PixelValueMin, double PixelValueMax)
void	SetPostscaleOffset (INT64 offset)
void	SetPrescaleOffset (INT64 offset)
void	SetScale (double Scale)
void	SetScaleRational (INT32 Numerator, INT32 Denominator)
void	SetTileFolderBasePath (const FILEPATH &filepath)
void	SetUsePalette (bool UsePalette=true)
void	SetZipOutput (bool ZipOutput=true, bool DeleteAfterZip=false)
Protected Member Functions
	TARGET_TILESET_FILE (STAGE *pInputStage, INT32 TileSize, IMAGE::TILESET::PROFILE profile)
	TARGET_TILESET_FILE (STAGE *pInputStage, INT32 TileSize, IMAGE::TILESET::PROFILE profile, const IMAGE::FORMAT format)
	TARGET_TILESET_FILE (STAGE *pInputStage, const IMAGE::TILESET &tileset)
ERRVALUE	CreateTargetFile (IMAGE::STAGE pStageInput, const FILEPATH &filepath, bool HasNullCells, IMAGE::TARGET_FILE &pTargetFile) const
ERRVALUE	CreateTargetFile (IMAGE::STAGE pStageInput, const FILEPATH &filepath, const IMAGE::FORMAT &format, IMAGE::TARGET_FILE &pTargetFile) const
const IMAGE::FORMAT *	FindTileFile (FILEPATH &filepath, const LPOINT3D &TileIdx) const
ERRVALUE	GenerateTileFilePath (FILEPATH &filepath, const LPOINT3D &TileIdx, bool HasNullCells, bool CreateFolder) const
virtual const IMAGE::FORMAT *	v_FindTileFile (FILEPATH &filepath, const LPOINT3D &TileIdx) const
virtual ERRVALUE	v_GenerateTileFilePath (FILEPATH &filepath, const LPOINT3D &TileIdx, bool HasNullCells, bool CreateFolder) const
virtual ERRVALUE	v_WriteTile (SOURCE_MEMORY &SourceTile, const LPOINT3D &TileIdx, bool HasNullCells)
Private Member Functions
virtual ERRVALUE	v_CreateTargetFile (IMAGE::STAGE pStageInput, const FILEPATH &filepath, const IMAGE::FORMAT &format, IMAGE::TARGET_FILE &pTargetFile) const

Detailed Description

Target base class for outputting tileset as files.

Constructor & Destructor Documentation

virtual SPATMOD::IMAGE::TARGET_TILESET_FILE::~TARGET_TILESET_FILE ( ) [virtual]

Destructor.

SPATMOD::IMAGE::TARGET_TILESET_FILE::TARGET_TILESET_FILE	(	STAGE *	pInputStage,
		const IMAGE::TILESET &	tileset
	)			`[protected]`

Construct with TILESET specification.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	tileset	Complete tileset specification

SPATMOD::IMAGE::TARGET_TILESET_FILE::TARGET_TILESET_FILE	(	STAGE *	pInputStage,
		INT32	TileSize,
		IMAGE::TILESET::PROFILE	profile,
		const IMAGE::FORMAT	format
	)			`[protected]`

Construct with tilesize, profile and format.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	TileSize	Tile Size
	profile	Tileset profile
	format	Image tile file format

SPATMOD::IMAGE::TARGET_TILESET_FILE::TARGET_TILESET_FILE	(	STAGE *	pInputStage,
		INT32	TileSize,
		IMAGE::TILESET::PROFILE	profile
	)			`[protected]`

Construct with tilesize and profile.

Parameters:

	pInputStage	Stage in pipeline to obtain image data from
	TileSize	Tile Size
	profile	Tileset profile

Member Function Documentation

ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::CreateCatalogExcludeFile ( )

Create catalog exclude file in tiles folder.

ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::CreateTargetFile	(	IMAGE::STAGE *	pStageInput,
		const FILEPATH &	filepath,
		bool	HasNullCells,
		IMAGE::TARGET_FILE *&	pTargetFile
	)			const `[protected]`

Create IMAGE::TARGET_FILE for output of single tile, format based on whether has null cells.

Parameters:

	pStageInput	Source containing single tile
	filepath	Tile file path
	HasNullCells	Set if tile has null cells
	pTargetFile	Pointer returned, will be deleted by caller

ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::CreateTargetFile	(	IMAGE::STAGE *	pStageInput,
		const FILEPATH &	filepath,
		const IMAGE::FORMAT &	format,
		IMAGE::TARGET_FILE *&	pTargetFile
	)			const `[protected]`

Create IMAGE::TARGET_FILE for output of single tile using specified format.

Parameters:

	pStageInput	Source containing single tile
	filepath	Tile file path
	format	File format
	pTargetFile	Pointer returned, will be deleted by caller

const IMAGE::FORMAT* SPATMOD::IMAGE::TARGET_TILESET_FILE::FindTileFile	(	FILEPATH &	filepath,
		const LPOINT3D &	TileIdx
	)			const `[inline, protected]`

Find tile file if exists.

Returns:: Pointer to format for tile file if found, NULL if not found.

Parameters:

	filepath	Tile file path returned
	TileIdx	Tile index (x = column, y = row, z = zoom level)

ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::GenerateTileFilePath	(	FILEPATH &	filepath,
		const LPOINT3D &	TileIdx,
		bool	HasNullCells,
		bool	CreateFolder
	)			const `[inline, protected]`

Generate path to tile file.

Parameters:

	filepath	Tile file path returned
	TileIdx	Tile index (x = column, y = row, z = zoom level)
	HasNullCells	Set if tile has null cells
	CreateFolder	Create folder if does not exist

bool SPATMOD::IMAGE::TARGET_TILESET_FILE::GetCreateAdditionalFiles ( ) const [inline]

Get whether to create addition files (TSD, html, etc).

bool SPATMOD::IMAGE::TARGET_TILESET_FILE::GetDeleteAfterZip ( ) const [inline]

Get whether to delete files after zipping.

bool SPATMOD::IMAGE::TARGET_TILESET_FILE::GetMakeTileMap ( ) const [inline]

Get whether to make tile map.

double SPATMOD::IMAGE::TARGET_TILESET_FILE::GetPixelValueMax ( ) const [inline]

Get maximum pixel value.

Use GetPixelRangeType() to determine if specific to image.

Reimplemented from SPATMOD::IMAGE::BASE.

double SPATMOD::IMAGE::TARGET_TILESET_FILE::GetPixelValueMin ( ) const [inline]

Get minimum pixel value.

Use GetPixelRangeType() to determine if specific to image.

Reimplemented from SPATMOD::IMAGE::BASE.

INT64 SPATMOD::IMAGE::TARGET_TILESET_FILE::GetPostscaleOffset ( ) const [inline]

INT64 SPATMOD::IMAGE::TARGET_TILESET_FILE::GetPrescaleOffset ( ) const [inline]

double SPATMOD::IMAGE::TARGET_TILESET_FILE::GetScale ( ) const [inline]

Scale to meters.

INT32 SPATMOD::IMAGE::TARGET_TILESET_FILE::GetScaleDenominator ( ) const [inline]

INT32 SPATMOD::IMAGE::TARGET_TILESET_FILE::GetScaleNumerator ( ) const [inline]

const FILEPATH& SPATMOD::IMAGE::TARGET_TILESET_FILE::GetTileFolderBasePath ( ) const [inline]

Get tile folder base path.

bool SPATMOD::IMAGE::TARGET_TILESET_FILE::GetUsePalette ( ) const [inline]

Get whether to use palette for output tiles.

bool SPATMOD::IMAGE::TARGET_TILESET_FILE::GetZipOutput ( ) const [inline]

Get whether to zip output.

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetCreateAdditionalFiles ( bool CreateAdditionalFiles ) [inline]

Set whether to create addition files (TSD, html, etc).

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetMakeTileMap ( bool MakeTileMap ) [inline]

Set whether to make tile map.

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetPixelValueRange	(	double	PixelValueMin,
		double	PixelValueMax
	)			`[inline]`

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetPostscaleOffset ( INT64 offset ) [inline]

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetPrescaleOffset ( INT64 offset ) [inline]

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetScale ( double Scale ) [inline]

Scale to meters.

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetScaleRational	(	INT32	Numerator,
		INT32	Denominator
	)			`[inline]`

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetTileFolderBasePath ( const FILEPATH & filepath ) [inline]

Set tile folder base path.

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetUsePalette ( bool UsePalette = true ) [inline]

Set to use a color palette for output tiles Not supported for JPEG.

void SPATMOD::IMAGE::TARGET_TILESET_FILE::SetZipOutput	(	bool	ZipOutput = `true`,
		bool	DeleteAfterZip = `false`
	)			`[inline]`

Zip the output.

virtual ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::v_CreateTargetFile	(	IMAGE::STAGE *	pStageInput,
		const FILEPATH &	filepath,
		const IMAGE::FORMAT &	format,
		IMAGE::TARGET_FILE *&	pTargetFile
	)			const `[private, virtual]`

Create IMAGE::TARGET_FILE for output of single tile.

Must be overridden if default v_WriteTile is used as default implementation simply returns EProgramError.

Parameters:

	pStageInput	Source containing single tile
	filepath	Tile file path
	format	File format
	pTargetFile	Pointer returned, will be deleted by caller

virtual const IMAGE::FORMAT* SPATMOD::IMAGE::TARGET_TILESET_FILE::v_FindTileFile	(	FILEPATH &	filepath,
		const LPOINT3D &	TileIdx
	)			const `[protected, virtual]`

Find tile file if exists.

Returns:: Pointer to format for tile file if found, NULL if not found. Default implementation passes TileFolderBasePath to TILESET's FindTileFile

Parameters:

	filepath	Tile file path returned
	TileIdx	Tile index (x = column, y = row, z = zoom level)

virtual ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::v_GenerateTileFilePath	(	FILEPATH &	filepath,
		const LPOINT3D &	TileIdx,
		bool	HasNullCells,
		bool	CreateFolder
	)			const `[protected, virtual]`

Generate path to tile file.

Default implementation uses structure defined in TILESET, with file extension based on FORMAT::SPEC. If more than one format is supported then will use first suitable based on value of HasNullCells.

Parameters:

	filepath	Tile file path returned
	TileIdx	Tile index (x = column, y = row, z = zoom level)
	HasNullCells	Set if tile has null cells
	CreateFolder	Create folder if does not exist

virtual ERRVALUE SPATMOD::IMAGE::TARGET_TILESET_FILE::v_WriteTile	(	SOURCE_MEMORY &	SourceTile,
		const LPOINT3D &	TileIdx,
		bool	HasNullCells
	)			`[protected, virtual]`

Write tile.

Uses GenerateTileFilePath and CreateTargetFile.

Parameters:

	SourceTile	Source for accessing data to write tile
	TileIdx	Tile index (x = column, y = row, z = zoom level)
	HasNullCells	True if tile has any null cells

Implements SPATMOD::IMAGE::TARGET_TILESET.

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

spatmod/imagetargettilesetfile.h

SPATMOD::IMAGE::TARGET_TILESET_FILE Class Reference

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation