IRasChartInfo Interface Reference
Details of a raster chart. More...
import "_encxcom_encx.idl";
Properties | |
| VARIANT_BOOL * | IsComplete [get] |
| Returns true iff the chart is fully installed. | |
| VARIANT_BOOL * | RequiresLicence [get] |
| All ARCS charts require a license. Some BSB charts require a license. | |
| VARIANT_BOOL * | IsWithdrawn [get] |
| Returns true if the chart's supplier has withdrawn the chart. | |
| BSTR * | NativeFormatLongDescription [get] |
| The description of the original format of the chart. E.g Admiralty Raster Chart Service. | |
| BSTR * | NativeFormatShortDescription [get] |
| The short description of the original format of the chart. E.g ARCS. | |
| BSTR * | Number [get] |
| The identity of the chart. Never blank. E.g. 2182C. | |
| BSTR * | InternationalNumber [get] |
| The internationally agreed identity of the chart. Often blank. | |
| BSTR * | Description [get] |
| A meaningful name for the whole chart. | |
| BSTR * | CountryOfOrigin [get] |
| Descripton of the country that produced the original chart. | |
| BSTR * | Producer1 [get] |
| Description of the country that produced the original chart. E.g. United Kingdom. | |
| BSTR * | Producer2 [get] |
| Description of the second country that produced the original chart. Often blank. | |
| DATE * | RasterChartIssueDate [get] |
| DATE * | EditionDate [get] |
| When this edition of the chart was created. | |
| DATE * | LastChanged [get] |
| When the last update was applied to this chart. | |
| DATE * | LatestCorrectionDate [get] |
| When the last update that has been applied was issued by the data producer. | |
| IRasDiscIdentity ** | InstallationCD [get] |
| The CD from which the chart was / can be installed. | |
| IRasDiscIdentity ** | MissingReInstallationCD [get] |
| The CD from which the chart needs to be re-installed. | |
| IRasDiscIdentity ** | MissingUpdateCD [get] |
| The CD from which the chart needs to be updated. | |
| IRasNoticeToMarinersNumber ** | LatestNoticeToMarinersNumber [get] |
| The Notices to Mariners number of the latest update installed. | |
| IRasNoticesToMariners ** | NoticesToMariners [get] |
| Obtain the Temporary and Preliminary Notices to Mariners corresponding to the latest update installed. | |
| IRasPanelIdentifiers ** | PanelIdentifiers [get] |
| Obtain a list of all the panels in the chart. | |
| IRasPanelInfo ** | PanelInfo ([in] IRasPanelIdentifier *panelId) [get] |
| Obtain the details of a specified panel. | |
Detailed Description
Details of a raster chart.All the information that is available about a chart without actually opening the chart.
Definition at line 932 of file _encxcom_encx.idl.
Property Documentation
VARIANT_BOOL* IRasChartInfo::IsComplete [get] |
Returns true iff the chart is fully installed.
Only licensed charts are fully installed. Unlicensed charts are installed as stub files, giving sufficient information to show that the chart exists and some basic properties, but without the information to display the chart.
VARIANT_BOOL* IRasChartInfo::RequiresLicence [get] |
All ARCS charts require a license. Some BSB charts require a license.
VARIANT_BOOL* IRasChartInfo::IsWithdrawn [get] |
Returns true if the chart's supplier has withdrawn the chart.
A withdrawn chart can stil be displayed up to the time that its licence expires. However such display should be acompanied by a warning that the chart has been withdrawn.
BSTR* IRasChartInfo::NativeFormatLongDescription [get] |
The description of the original format of the chart. E.g Admiralty Raster Chart Service.
BSTR* IRasChartInfo::NativeFormatShortDescription [get] |
The short description of the original format of the chart. E.g ARCS.
BSTR* IRasChartInfo::Number [get] |
The identity of the chart. Never blank. E.g. 2182C.
BSTR* IRasChartInfo::InternationalNumber [get] |
The internationally agreed identity of the chart. Often blank.
BSTR* IRasChartInfo::Description [get] |
A meaningful name for the whole chart.
BSTR* IRasChartInfo::CountryOfOrigin [get] |
Descripton of the country that produced the original chart.
BSTR* IRasChartInfo::Producer1 [get] |
Description of the country that produced the original chart. E.g. United Kingdom.
BSTR* IRasChartInfo::Producer2 [get] |
Description of the second country that produced the original chart. Often blank.
DATE* IRasChartInfo::RasterChartIssueDate [get] |
DATE* IRasChartInfo::EditionDate [get] |
When this edition of the chart was created.
Also printed in the bottom left corner of many ARCS charts.
DATE* IRasChartInfo::LastChanged [get] |
When the last update was applied to this chart.
DATE* IRasChartInfo::LatestCorrectionDate [get] |
When the last update that has been applied was issued by the data producer.
IRasDiscIdentity ** IRasChartInfo::InstallationCD [get] |
The CD from which the chart was / can be installed.
IRasDiscIdentity ** IRasChartInfo::MissingReInstallationCD [get] |
The CD from which the chart needs to be re-installed.
This CD contains a later edition of the chart than is currently installed.
IRasDiscIdentity ** IRasChartInfo::MissingUpdateCD [get] |
The CD from which the chart needs to be updated.
This CD contains later corrections to the chart than are currently installed.
IRasNoticeToMarinersNumber ** IRasChartInfo::LatestNoticeToMarinersNumber [get] |
The Notices to Mariners number of the latest update installed.
Also printed in the bottom left corner of many ARCS charts.
IRasNoticesToMariners ** IRasChartInfo::NoticesToMariners [get] |
Obtain the Temporary and Preliminary Notices to Mariners corresponding to the latest update installed.
IRasPanelIdentifiers ** IRasChartInfo::PanelIdentifiers [get] |
Obtain a list of all the panels in the chart.
IRasPanelInfo ** IRasChartInfo::PanelInfo([in] IRasPanelIdentifier * panelId) [get] |
Obtain the details of a specified panel.
Specify the panel using one of the values obtained from PanelIdentifiers().