SPATMOD::IMAGE::SOURCE_HTTP Class Reference

Source to send HTTP request and manage reply. More...

#include <spatmod/imagesourcehttp.h>

Inheritance diagram for SPATMOD::IMAGE::SOURCE_HTTP:

[legend]

List of all members.

Public Types
enum	STATUS { STATUS_Waiting, STATUS_Complete, STATUS_Failed }
Public Member Functions
	SOURCE_HTTP (const MISTRING &url, const PIXEL &PixelProp, UINT32 TotalColumns, UINT32 TotalRows, const TRANS2D_MAPGEN *pTransToCRS=0)
virtual	~SOURCE_HTTP ()
ERRVALUE	GetErrValue () const
STATUS	GetStatus () const

---

Detailed Description

Source to send HTTP request and manage reply.

Will use the MIME content type to determine the actual image format. Unlike most other sources, the dimensions and pixel properties of this source might change, which if happens will occur when the notification of the reply is sent. Normally this occurs during UI idle processing. For this reason, care must be taken when using this class, and typically should avoid having later stages in the pipeline take ownership, as most stages will determine their own dimensions and pixel properties during construction or initialization and will not handle subsequent changes.

---

Member Enumeration Documentation

enum SPATMOD::IMAGE::SOURCE_HTTP::STATUS

Status enumeration.

Enumerator:

STATUS_Waiting	Waiting for reply, placeholder content available.
STATUS_Complete	Request complete, final content available.
STATUS_Failed	Failed, use GetErrValue to get error code.

---

Constructor & Destructor Documentation

SPATMOD::IMAGE::SOURCE_HTTP::SOURCE_HTTP	(	const MISTRING &	url,
		const PIXEL &	PixelProp,
		UINT32	TotalColumns,
		UINT32	TotalRows,
		const TRANS2D_MAPGEN *	pTransToCRS = 0
	)

Constructor.

Parameters:

	url	URL string
	PixelProp	Pixel properties for placeholder
	TotalColumns	Total columns for placeholder
	TotalRows	Total rows for placeholder
	pTransToCRS	Transformation from device to map CRS

virtual SPATMOD::IMAGE::SOURCE_HTTP::~SOURCE_HTTP

(

)

[virtual]

---

Member Function Documentation

ERRVALUE SPATMOD::IMAGE::SOURCE_HTTP::GetErrValue

(

)

const [inline]

Get error value (for STATUS_Failed).

STATUS SPATMOD::IMAGE::SOURCE_HTTP::GetStatus

(

)

const [inline]

Get current status.

---

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

• spatmod/imagesourcehttp.h