ENCX SDK  5.5.0.370
Properties | List of all members
IRasChartInfo Interface Reference

Details of a raster chart. More...

import"encxcom.idl";

Inheritance diagram for IRasChartInfo:
Inheritance graph
[legend]

Properties

VARIANT_BOOL IsComplete [get]
 Returns true iff the chart is fully installed. More...
 
VARIANT_BOOL RequiresLicence [get]
 All ARCS charts require a license. More...
 
VARIANT_BOOL IsWithdrawn [get]
 Returns true if the chart's supplier has withdrawn the chart. More...
 
BSTR NativeFormatLongDescription [get]
 The description of the original format of the chart. E.g Admiralty Raster Chart Service. More...
 
BSTR NativeFormatShortDescription [get]
 The short description of the original format of the chart. E.g ARCS. More...
 
BSTR Number [get]
 The identity of the chart. Never blank. E.g. 2182C. More...
 
BSTR InternationalNumber [get]
 The internationally agreed identity of the chart. Often blank. More...
 
BSTR Description [get]
 A meaningful name for the whole chart. More...
 
BSTR CountryOfOrigin [get]
 Description of the country that produced the original chart. More...
 
BSTR Producer1 [get]
 Description of the country that produced the original chart. E.g. United Kingdom. More...
 
BSTR Producer2 [get]
 Description of the second country that produced the original chart. Often blank. More...
 
DATE RasterChartIssueDate [get]
 
DATE EditionDate [get]
 When this edition of the chart was created. More...
 
DATE LastChanged [get]
 When the last update was applied to this chart. More...
 
DATE LatestCorrectionDate [get]
 When the last update that has been applied was issued by the data producer. More...
 
IRasDiscIdentity InstallationCD [get]
 The CD from which the chart was / can be installed. More...
 
IRasDiscIdentity MissingReInstallationCD [get]
 The CD from which the chart needs to be re-installed. More...
 
IRasDiscIdentity MissingUpdateCD [get]
 The CD from which the chart needs to be updated. More...
 
IRasNoticeToMarinersNumber LatestNoticeToMarinersNumber [get]
 The Notices to Mariners number of the latest update installed. More...
 
IRasNoticesToMariners NoticesToMariners [get]
 Obtain the Temporary and Preliminary Notices to Mariners corresponding to the latest update installed. More...
 
IRasPanelIdentifiers PanelIdentifiers [get]
 Obtain a list of all the panels in the chart. More...
 
IRasPanelInfo PanelInfo ([in] IRasPanelIdentifier panelId) [get]
 Obtain the details of a specified panel. More...
 

Detailed Description

Details of a raster chart.

All the information that is available about a chart without actually opening the chart.

Definition at line 1140 of file encxcom.idl.

Property Documentation

◆ CountryOfOrigin

BSTR IRasChartInfo::CountryOfOrigin
getproperty

Description of the country that produced the original chart.

◆ Description

BSTR IRasChartInfo::Description
getproperty

A meaningful name for the whole chart.

◆ EditionDate

DATE IRasChartInfo::EditionDate
getproperty

When this edition of the chart was created.

Also printed in the bottom left corner of many ARCS charts.

◆ InstallationCD

IRasDiscIdentity IRasChartInfo::InstallationCD
getproperty

The CD from which the chart was / can be installed.

◆ InternationalNumber

BSTR IRasChartInfo::InternationalNumber
getproperty

The internationally agreed identity of the chart. Often blank.

◆ IsComplete

VARIANT_BOOL IRasChartInfo::IsComplete
getproperty

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.

◆ IsWithdrawn

VARIANT_BOOL IRasChartInfo::IsWithdrawn
getproperty

Returns true if the chart's supplier has withdrawn the chart.

A withdrawn chart can still be displayed up to the time that its licence expires. However such display should be accompanied by a warning that the chart has been withdrawn.

◆ LastChanged

DATE IRasChartInfo::LastChanged
getproperty

When the last update was applied to this chart.

◆ LatestCorrectionDate

DATE IRasChartInfo::LatestCorrectionDate
getproperty

When the last update that has been applied was issued by the data producer.

◆ LatestNoticeToMarinersNumber

IRasNoticeToMarinersNumber IRasChartInfo::LatestNoticeToMarinersNumber
getproperty

The Notices to Mariners number of the latest update installed.

Also printed in the bottom left corner of many ARCS charts.

◆ MissingReInstallationCD

IRasDiscIdentity IRasChartInfo::MissingReInstallationCD
getproperty

The CD from which the chart needs to be re-installed.

This CD contains a later edition of the chart than is currently installed.

◆ MissingUpdateCD

IRasDiscIdentity IRasChartInfo::MissingUpdateCD
getproperty

The CD from which the chart needs to be updated.

This CD contains later corrections to the chart than are currently installed.

◆ NativeFormatLongDescription

BSTR IRasChartInfo::NativeFormatLongDescription
getproperty

The description of the original format of the chart. E.g Admiralty Raster Chart Service.

◆ NativeFormatShortDescription

BSTR IRasChartInfo::NativeFormatShortDescription
getproperty

The short description of the original format of the chart. E.g ARCS.

◆ NoticesToMariners

IRasNoticesToMariners IRasChartInfo::NoticesToMariners
getproperty

Obtain the Temporary and Preliminary Notices to Mariners corresponding to the latest update installed.

◆ Number

BSTR IRasChartInfo::Number
getproperty

The identity of the chart. Never blank. E.g. 2182C.

◆ PanelIdentifiers

IRasPanelIdentifiers IRasChartInfo::PanelIdentifiers
getproperty

Obtain a list of all the panels in the chart.

◆ PanelInfo

IRasPanelInfo IRasChartInfo::PanelInfo([in] IRasPanelIdentifier panelId)
getproperty

Obtain the details of a specified panel.

Specify the panel using one of the values obtained from PanelIdentifiers().

◆ Producer1

BSTR IRasChartInfo::Producer1
getproperty

Description of the country that produced the original chart. E.g. United Kingdom.

◆ Producer2

BSTR IRasChartInfo::Producer2
getproperty

Description of the second country that produced the original chart. Often blank.

◆ RasterChartIssueDate

DATE IRasChartInfo::RasterChartIssueDate
getproperty

◆ RequiresLicence

VARIANT_BOOL IRasChartInfo::RequiresLicence
getproperty

All ARCS charts require a license.