SOA::WMS::CONNECTION Class Reference

Container for information about connection to a WMS server. More...

#include <soa/wmsconnection.h>

List of all members.

Public Member Functions

 CONNECTION (const CONNECTION &)
 CONNECTION ()
 ~CONNECTION ()
ERRVALUE BuildGetFeatureInfoRequest (MISTRING &RequestURL, const MISTRINGLIST &LayerNameList, const MISTRINGLIST &LayerStyleList, const SPATREF::COORDREFSYS &CoordRefSys, const DRECT2D &BoundingBox, INT32 TgtWidth, INT32 TgtHeight, const MIMETYPE &ImageFormat, const MISTRINGLIST &QueryLayerList, const MIMETYPE &InfoFormat, INT32 PixelColumn, INT32 PixelRow, INT32 FeatureCount=1) const
ERRVALUE BuildGetMapRequest (MISTRING &RequestURL, const MISTRINGLIST &LayerNameList, const MISTRINGLIST &LayerStyleList, const SPATREF::COORDREFSYS &CoordRefSys, const DRECT2D &BoundingBox, INT32 TgtWidth, INT32 TgtHeight, const MIMETYPE &Format, const COLOR *pColorBG=0) const
ERRVALUE DoGetCapabilities (bool synchronous, MDLGPARENT dlgparent=0)
ERRVALUE DoGetCapabilities (const MISTRING &ServerURL, bool synchronous, MDLGPARENT dlgparent=0)
const WMS::CAPABILITIESGetCapabilities () const
const MISTRINGGetPassword () const
const MISTRINGGetServerURL () const
const MISTRINGGetUsername () const
bool HasCapabilities () const
CONNECTIONoperator= (const CONNECTION &)
void SetDoAuthDialog (const bool doAuth)
void SetServerURL (const MISTRING &ServerURL)

Detailed Description

Container for information about connection to a WMS server.

Includes Server URL and capabilities, and provides methods to send service requests.


Constructor & Destructor Documentation

SOA::WMS::CONNECTION::CONNECTION (  ) 

Constructor.

SOA::WMS::CONNECTION::CONNECTION ( const CONNECTION  ) 

Copy constructor.

SOA::WMS::CONNECTION::~CONNECTION (  ) 

Destructor.


Member Function Documentation

ERRVALUE SOA::WMS::CONNECTION::BuildGetFeatureInfoRequest ( MISTRING RequestURL,
const MISTRINGLIST LayerNameList,
const MISTRINGLIST LayerStyleList,
const SPATREF::COORDREFSYS CoordRefSys,
const DRECT2D BoundingBox,
INT32  TgtWidth,
INT32  TgtHeight,
const MIMETYPE ImageFormat,
const MISTRINGLIST QueryLayerList,
const MIMETYPE InfoFormat,
INT32  PixelColumn,
INT32  PixelRow,
INT32  FeatureCount = 1 
) const

Build "GetFeatureInfo" request URL string.

Parameters:
RequestURL Request URL returned
LayerNameList List of layers to request
LayerStyleList Corresponding layer style list
CoordRefSys CRS for bounding box and rendering
BoundingBox Bounding box
TgtWidth Target width in pixels
TgtHeight Target height in pixels
ImageFormat Image format MIME type
QueryLayerList List of layers to query
InfoFormat Format for returning feature info
PixelColumn Column coordinate of position to query
PixelRow Row coordinate of position to query
FeatureCount Feature count
ERRVALUE SOA::WMS::CONNECTION::BuildGetMapRequest ( MISTRING RequestURL,
const MISTRINGLIST LayerNameList,
const MISTRINGLIST LayerStyleList,
const SPATREF::COORDREFSYS CoordRefSys,
const DRECT2D BoundingBox,
INT32  TgtWidth,
INT32  TgtHeight,
const MIMETYPE Format,
const COLOR pColorBG = 0 
) const

Build "GetMap" request URL string.

Parameters:
RequestURL Request URL returned
LayerNameList List of layers to request
LayerStyleList Corresponding layer style list
CoordRefSys CRS for bounding box and rendering
BoundingBox Bounding box
TgtWidth Target width in pixels
TgtHeight Target height in pixels
Format Format MIME type
pColorBG Optional background color
ERRVALUE SOA::WMS::CONNECTION::DoGetCapabilities ( bool  synchronous,
MDLGPARENT  dlgparent = 0 
)

Send "GetCapabilities" request to previously specified server.

If already have capabilities will not request again.

Parameters:
dlgparent Parent for status dialog if want to show
ERRVALUE SOA::WMS::CONNECTION::DoGetCapabilities ( const MISTRING ServerURL,
bool  synchronous,
MDLGPARENT  dlgparent = 0 
)

Send "GetCapabilities" request to specified server.

If matches previous setting will not request again.

Parameters:
dlgparent Parent for status dialog if want to show
const WMS::CAPABILITIES& SOA::WMS::CONNECTION::GetCapabilities (  )  const

Get capabilities as returned from server.

If an asynchronous request for capabilities was made and which may still be open then must call HasCapabilities first and only call this method if returns true.

const MISTRING& SOA::WMS::CONNECTION::GetPassword (  )  const [inline]
const MISTRING& SOA::WMS::CONNECTION::GetServerURL (  )  const [inline]

Get URL for server.

const MISTRING& SOA::WMS::CONNECTION::GetUsername (  )  const [inline]
bool SOA::WMS::CONNECTION::HasCapabilities (  )  const [inline]

Determine if have capabilities available.

CONNECTION& SOA::WMS::CONNECTION::operator= ( const CONNECTION  ) 

Assignment.

void SOA::WMS::CONNECTION::SetDoAuthDialog ( const bool  doAuth  )  [inline]
void SOA::WMS::CONNECTION::SetServerURL ( const MISTRING ServerURL  ) 

Set URL for server.

If does not match existing then capabilities will be discarded.


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

Generated on Sun Oct 7 21:39:23 2012 for TNTsdk 2012 by  doxygen 1.6.1