SOA::ARCIMS::CONNECTION Class Reference

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

#include <soa/arcimsconnection.h>

List of all members.

Public Member Functions

 CONNECTION (const CONNECTION &)
 CONNECTION ()
virtual ~CONNECTION ()
ERRVALUE BuildGetFeatureInfoRequest (HTTPMESSAGE &RequestHdrs, XMLDOC &RequestBody, 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 BuildGetImageRequest (HTTPMESSAGE &RequestHdrs, XMLDOC &RequestBody, const MISTRINGLIST &LayerIDList, const SPATREF::COORDREFSYS &CoordRefSys, const DRECT2D &BoundingBox, INT32 TgtWidth, INT32 TgtHeight, const MIMETYPE &Format, bool bRequestImage=true, const COLOR *pColorBG=0) const
ERRVALUE BuildGetLegendRequest (HTTPMESSAGE &RequestHdrs, XMLDOC &RequestBody, const MISTRINGLIST &LayerIDList, const MIMETYPE &Format, const COLOR *pLegendBGColor=0) const
ERRVALUE DoGetServiceInfo (bool synchronous, MDLGPARENT dlgparent=0)
ERRVALUE DoGetServiceInfo (const MISTRING &ServerURL, bool synchronous, MDLGPARENT dlgparent=0)
const MIMETYPEGetImageType () const
const MISTRINGGetServerURL () const
const ARCIMS::SERVICEINFOGetServiceInfo () const
MISTRING GetServiceTitle () const
MISTRING GetServiceToolTip () const
bool HasServiceInfo () const
CONNECTIONoperator= (const CONNECTION &)
void SetServerURL (const MISTRING &ServerURL)

Static Public Member Functions

static bool IsCompatibleURL (const MISTRING &url)

Detailed Description

Container for information about connection to a ARCIMS server.

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


Constructor & Destructor Documentation

SOA::ARCIMS::CONNECTION::CONNECTION (  ) 

Constructor.

SOA::ARCIMS::CONNECTION::CONNECTION ( const CONNECTION  ) 

Copy constructor.

virtual SOA::ARCIMS::CONNECTION::~CONNECTION (  )  [virtual]

Destructor.


Member Function Documentation

ERRVALUE SOA::ARCIMS::CONNECTION::BuildGetFeatureInfoRequest ( HTTPMESSAGE RequestHdrs,
XMLDOC RequestBody,
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:
RequestHdrs Request headers to send
RequestBody Request body to send
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::ARCIMS::CONNECTION::BuildGetImageRequest ( HTTPMESSAGE RequestHdrs,
XMLDOC RequestBody,
const MISTRINGLIST LayerIDList,
const SPATREF::COORDREFSYS CoordRefSys,
const DRECT2D BoundingBox,
INT32  TgtWidth,
INT32  TgtHeight,
const MIMETYPE Format,
bool  bRequestImage = true,
const COLOR pColorBG = 0 
) const

Build "GET_IMAGE" request message.

Unlike WMS in which the request is an HTTP GET request, ArcIMS uses HTTP POST. Also, the reply from a WMS GetMap request is the image. The reply from an ArcIMS GET_IMAGE is XML which may contain the image or a url to the image.

Parameters:
RequestHdrs Request headers to send
RequestBody Request body to send
LayerIDList List of layers to request
CoordRefSys CRS for bounding box and rendering
BoundingBox Bounding box
TgtWidth Target width in pixels
TgtHeight Target height in pixels
Format Format MIME type
bRequestImage Request main image
pColorBG Optional background color
ERRVALUE SOA::ARCIMS::CONNECTION::BuildGetLegendRequest ( HTTPMESSAGE RequestHdrs,
XMLDOC RequestBody,
const MISTRINGLIST LayerIDList,
const MIMETYPE Format,
const COLOR pLegendBGColor = 0 
) const
Parameters:
RequestHdrs Request headers to send
RequestBody Request body to send
LayerIDList List of layers to request
Format Format MIME type
pLegendBGColor Optional background color for legend graphic
ERRVALUE SOA::ARCIMS::CONNECTION::DoGetServiceInfo ( bool  synchronous,
MDLGPARENT  dlgparent = 0 
)

Send "GET_SERVICE_INFO" 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::ARCIMS::CONNECTION::DoGetServiceInfo ( const MISTRING ServerURL,
bool  synchronous,
MDLGPARENT  dlgparent = 0 
)

Send "GET_SERVICE_INFO" request to previously specified server.

If already have capabilities will not request again.

Parameters:
dlgparent Parent for status dialog if want to show
const MIMETYPE& SOA::ARCIMS::CONNECTION::GetImageType (  )  const [inline]
const MISTRING& SOA::ARCIMS::CONNECTION::GetServerURL (  )  const [inline]
const ARCIMS::SERVICEINFO& SOA::ARCIMS::CONNECTION::GetServiceInfo (  )  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.

MISTRING SOA::ARCIMS::CONNECTION::GetServiceTitle (  )  const

Get the title for the service.

MISTRING SOA::ARCIMS::CONNECTION::GetServiceToolTip (  )  const

Get the tooltip for the service.

bool SOA::ARCIMS::CONNECTION::HasServiceInfo (  )  const [inline]

Determine if have service info available.

static bool SOA::ARCIMS::CONNECTION::IsCompatibleURL ( const MISTRING url  )  [static]

Return true if a URL is for this type of service.

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

Assignment.

void SOA::ARCIMS::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:21 2012 for TNTsdk 2012 by  doxygen 1.6.1