IRasPanelInfo Interface Reference

Details of a raster panel. More...

import"encxcom.idl";

Inheritance diagram for IRasPanelInfo:

Public Member Functions
HRESULT	PointInPanel ([in] DOUBLE dLatGeodeticDegrees, [in] DOUBLE dLonDegrees, [out, retval] VARIANT_BOOL *bRes)
	Returns true iff the specified geographical position is inside the panel. More...

Properties
BSTR	Description [get]
	A meaningful name for the panel. More...
BSTR	HeightDatum [get]
	The description of the vertical datum for heights. E.g. Mean High Water Springs. More...
BSTR	HeightUnits [get]
	The description of the units used for heights. More...
BSTR	DepthDatum [get]
	The description of the vertical datum for depths. E.g. Lowest Astronomical Tide. More...
BSTR	DepthUnits [get]
	The description of the units used for depths. More...
BSTR	ProjectionName [get]
	The description of the projection used by the chart. E.g. Mercator. More...
LONG	Scale [get]
	The nominal scale of the chart. Suitable for display to the user, but not for precise calculations. More...
IGeoHorizontalDatumInfo	HorizontalDatumInfo [get]
	Obtain details of the horizontal datum for this panel. More...
IGeoArea	GeoArea [get]
	Obtain the geographical extent of the panel. More...
LONG	PanelNumber [get]
	Obtain the number identifying this panel in the original source data. More...
LONG	SubPanelNumber [get]
	Obtain the subsidiary number identifying this panel in the original source data. More...
IPixelPoints	PixelPoints [get]
	Obtain the pixel extent of the panel. More...
VARIANT_BOOL	ManualWGS84ShiftCanBeModified [get]
	Returns true iff the horizontal datum shift can be modified using IRasManager.SetManualWGS84Shift(). More...
IGeoPoint	ManualWGS84Shift [get]
	Returns the manual horizontal datum shift. More...
VARIANT_BOOL	ManualWGS84ShiftIsSet [get]
	Returns true iff the horizontal datum shift has been modified programmatically. More...

Detailed Description

Details of a raster panel.

A panel is a geographically contiguous area of a raster chart. Most charts contain one large panel. Some charts contain insets which are additional panels. Some charts are a "chart of plans" and have no large panel. In all cases, each geographically contiguous area is a panel.

Definition at line 1084 of file encxcom.idl.

Member Function Documentation

PointInPanel()

HRESULT IRasPanelInfo::PointInPanel	(	[in] DOUBLE	dLatGeodeticDegrees,
		[in] DOUBLE	dLonDegrees,
		[out, retval] VARIANT_BOOL *	bRes
	)

Returns true iff the specified geographical position is inside the panel.

Property Documentation

DepthDatum

BSTR IRasPanelInfo::DepthDatum

getproperty

The description of the vertical datum for depths. E.g. Lowest Astronomical Tide.

DepthUnits

BSTR IRasPanelInfo::DepthUnits

getproperty

The description of the units used for depths.

Description

BSTR IRasPanelInfo::Description

getproperty

A meaningful name for the panel.

GeoArea

IGeoArea IRasPanelInfo::GeoArea

getproperty

Obtain the geographical extent of the panel.

HeightDatum

BSTR IRasPanelInfo::HeightDatum

getproperty

The description of the vertical datum for heights. E.g. Mean High Water Springs.

HeightUnits

BSTR IRasPanelInfo::HeightUnits

getproperty

The description of the units used for heights.

HorizontalDatumInfo

IGeoHorizontalDatumInfo IRasPanelInfo::HorizontalDatumInfo

getproperty

Obtain details of the horizontal datum for this panel.

ManualWGS84Shift

IGeoPoint IRasPanelInfo::ManualWGS84Shift

getproperty

Returns the manual horizontal datum shift.

ManualWGS84ShiftCanBeModified

VARIANT_BOOL IRasPanelInfo::ManualWGS84ShiftCanBeModified

getproperty

Returns true iff the horizontal datum shift can be modified using IRasManager.SetManualWGS84Shift().

Only panels with an undefined relationship to WGS84 can have their datum shifts modified programmatically.

ManualWGS84ShiftIsSet

VARIANT_BOOL IRasPanelInfo::ManualWGS84ShiftIsSet

getproperty

Returns true iff the horizontal datum shift has been modified programmatically.

The datum shifts are persisted in the registry.

PanelNumber

LONG IRasPanelInfo::PanelNumber

getproperty

Obtain the number identifying this panel in the original source data.

Only useful to display to the user with SubPanelNumber to identify the panel in a very brief format.

If the SubPanelNumber is -1 then it is the only subpanel within the PanelNumber.

PixelPoints

IPixelPoints IRasPanelInfo::PixelPoints

getproperty

Obtain the pixel extent of the panel.

ProjectionName

BSTR IRasPanelInfo::ProjectionName

getproperty

The description of the projection used by the chart. E.g. Mercator.

Scale

LONG IRasPanelInfo::Scale

getproperty

The nominal scale of the chart. Suitable for display to the user, but not for precise calculations.

SubPanelNumber

LONG IRasPanelInfo::SubPanelNumber

getproperty

Obtain the subsidiary number identifying this panel in the original source data.

Only useful to display to the user with PanelNumber to identify the panel in a very brief format.

If the SubPanelNumber is -1 then it is the only subpanel within the PanelNumber.