ENCX Object Model More...

Classes
interface	IDongle
	A security device. More...

interface	IDongleObserver
	Properties and methods for ENCX::DongleObserver. More...

interface	IGeoPointFormatter
	GeoPointFormatter. More...

interface	ILibrary
	Properties and methods for ENCX::Library. More...

interface	IDisplayPalette
	Properties and methods for ENCX::DisplayPalette. More...

interface	IGeoPoint
	Properties and methods for ENCX::GeoPoint. More...

interface	IGeoPoints
	Properties and methods for ENCX::GeoPoints. More...

interface	IGeoArea
	Properties and methods for ENCX::GeoArea. More...

interface	IGeoHorizontalDatumInfo
	Abbreviated and full descriptions of a horizontal datum. More...

interface	IGeoRect
	Properties and methods for ENCX::GeoRect. More...

interface	IGeoLine
	Properties and methods for ENCX::GeoLine. More...

interface	IPixelPoint
	Properties and methods for ENCX::PixelPoint. More...

interface	IPixelSize
	Properties and methods for ENCX::PixelSize. More...

interface	IPixelRect
	Properties and methods for ENCX::PixelRect. More...

interface	IPixelPoints
	A collection of pixel points. More...

interface	IPolyLines
	A collection of chains of pixel points. Returned by IGeoPix::Line. More...

interface	IPolyAreas
	A collection of rings of pixel points. Returned by IGeoPix::Area. More...

interface	IGeoPix
	A GeoPix represents a portion of chart visible on the screen. More...

interface	IGeoPixCollection
	A collection of geopixes. More...

interface	IHorizontalDatum
	A way to convert a geographical position between a local horizontal datum and WGS84. More...

interface	IRasCharts
	A collection of raster charts. More...

interface	IRasDiscIdentity
	A means of identifying a chart CD. More...

interface	IRasNoticeToMarinersNumber
	Identification for a notice to mariners. More...

interface	IRasNoticeToMariners
	A Notice to Mariners. More...

interface	IRasNoticesToMariners
	A collection of Notices to Mariners. More...

interface	IRasPanelIdentifier
	Properties and methods for ENCX::RasPanelIdentifier. More...

interface	IRasPanelIdentifiers
	A collection of raster panel identifiers. More...

interface	IRasChartPanelIdentifier
	The identity of a specific panel of a specific chart. More...

interface	IRasChartPanelIdentifiers
	A collection of raster chart panel identifiers. More...

interface	IRasPanelInfo
	Details of a raster panel. More...

interface	IRasChartInfo
	Details of a raster chart. More...

interface	IRasManager
	Properties and methods for ENCX::RasManager. More...

interface	IRasCatalogueObserver
	Properties and methods for ENCX::RasCatalogueObserver. More...

interface	IRasPanelNote
	Details of an explanatory note on a raster panel. More...

interface	IRasPanelNotes
	A collection of notes for a raster panel. More...

interface	IRasDraw
	Properties and methods for ENCX::RasDraw. More...

interface	IS57Attribute
	Classification of the properties associated with an S-57 feature. More...

interface	IS57AttributeValue
	An S-57 feature can contain many attributes. Each attribute has a type (IS57Attribute) and a value. More...

interface	IS57AttributeValues
	A collection of S-57 attribute values. More...

interface	IS57CellIdentifier
	Properties and methods for ENCX::S57CellIdentifier. More...

interface	IS57CellIdentifiers
	Properties and methods for ENCX::S57CellIdentifiers; a collection of S57CellIdentifier. More...

interface	IS57Colour
	Classification of the properties associated with an S-57 colour. More...

interface	IS57ColourValue
	An S-57 Colour Identifier combined with the RGB values of the colour for each colour scheme (Day, Twilight, Night). More...

interface	IS57ColourValues
	A collection of S-57 colours and associated RGB values. More...

interface	IS57ProductAndUsage
	Properties and methods for ENCX::S57ProductAndUsage. More...

interface	IS57ProductAndUsages
	A collection of S-57 product / intended usage pairs. More...

interface	IS57CellInfo
	Details of a single S-57 cell. More...

interface	IS57DepthPoint
	The combination of a geographical position and the depth at that position. More...

interface	IS57DepthPoints
	A collection of S-57 soundings (position and depth pairs). More...

interface	IS57Face
	A geographical area - a closed region on the surface of the earth. More...

interface	IS57Faces
	A collection of S-57 faces. More...

interface	IS57ObjectClass
	Properties and methods for ENCX::S57ObjectClass. More...

interface	IS57ObjectClassCollection
	A collection of S-57 Object Classes. More...

interface	IS57FeatureIdentifier
	Properties and methods for ENCX::S57FeatureIdentifier. More...

interface	IS57FeatureIdentifiers
	A collection of S-57 feature identifiers. More...

interface	IS57FeatureInfo
	Generic information. Can be used with any feature. More...

interface	IS57FeatureArea
	Information about a feature of 'Area' geometry. More...

interface	IS57FeatureLine
	Information about a feature of 'Line' geometry. More...

interface	IS57FeaturePoint
	Information about a feature of 'Point' geometry. More...

interface	IS57FeatureSounding
	Information about a collection of soundings. More...

interface	IS57DrawnFeature
	How a feature is (or would be) drawn. Obtained when hit-testing a S57Draw object. More...

interface	IS57DrawnFeatures
	A collection of features returned by hit-testing an S57Draw object. More...

interface	IS57DisplaySettings
	Properties and methods for ENCX::S57DisplaySettings. More...

interface	IWVSDisplaySettings
	Properties and methods for ENCX::WVSDisplaySettings. These settings only affect single-file WVS drawing. More...

interface	IGridPen
	Properties and methods for ENCX::GridPen. More...

interface	IGridDisplaySettings
	Properties and methods for ENCX::GridDisplaySettings. More...

interface	IS57ManagerInitialisationData
	Properties and methods for ENCX::S57ManagerInitialisationData. More...

interface	IS57Manager
	Properties and methods for ENCX::S57Manager. More...

interface	IS57FeatureQuery
	Properties and methods for ENCX::S57FeatureQuery. More...

interface	IS57CatalogueObserver
	Properties and methods for ENCX::S57CatalogueObserver. More...

interface	IVPFFeatureSet
	Properties and methods for ENCX::VPFFeatureSet. More...

interface	IVPFIteratorGuide_CoverageUse
	Properties and methods for ENCX::IVPFIteratorGuide_CoverageUse. More...

interface	IVPFIteratorGuide_LibraryUse
	Properties and methods for ENCX::IVPFIteratorGuide_LibraryUse. More...

interface	IVPFIteratorGuide_DatabaseUse
	Properties and methods for ENCX::VPFIteratorGuide_DatabaseUse. More...

interface	IVPFIteratorGuide
	Properties and methods for ENCX::VPFIteratorGuide. More...

interface	IVPFDisplaySettings
	Properties and methods for ENCX::VPFDisplaySettings. More...

interface	IVPFManager
	Properties and methods for ENCX::VPFManager. More...

interface	IVPFCatalogueObserver
	Properties and methods for ENCX::VPFCatalogueObserver. More...

interface	IS57Draw
	Properties and methods for ENCX::S57Draw. More...

interface	IHTMLGenerator
	Properties and methods for ENCX::HTMLGenerator. More...

interface	IRouteCheck
	Properties and methods for ENCX::RouteCheck. More...

class	ENCX::Library
	The top level object in the ENCX library. Required to create many other ENCX objects. More...

class	ENCX::DisplayPalette
	Specifies the type of palette and any fading of the chart. More...

interface	ENCX::_IDongleObserverEvents
	Events from DongleObserver. More...

class	ENCX::DongleObserver
	Observe the state of the security device. More...

class	ENCX::GeoPoint
	A position on the Earth's surface defined by geodetic latitude and longitude. More...

class	ENCX::GeoPoints
	Collection of GeoPoint objects. More...

class	ENCX::GeoArea
	An area formed by joining points in a closed loop with lines of the specified shape. More...

class	ENCX::GeoRect
	An area on the Earth's surface defined by two meridians (east and west) and two parallels (north and south). More...

class	ENCX::GeoLine
	A line of a specified shape between two points on the Earth's surface. More...

class	ENCX::RasManager
	Manage a folder of raster charts. More...

interface	ENCX::_IRasCatalogueObserverEvents
	Events from RasCatalogueObserver. More...

class	ENCX::RasCatalogueObserver
	Observe changes to the charts in a RasManager. More...

class	ENCX::RasChartPanelIdentifier
	The identity of a single panel (either the main chart or an inset panel) on a known raster chart. More...

class	ENCX::RasDraw
	Display a bounded raster chart via a Win32 Device Context. More...

interface	ENCX::_IS57CatalogueObserverEvents
	Events from S57CatalogueObserver. More...

class	ENCX::S57CatalogueObserver
	Observe changes to the cells in an S57Manager. More...

class	ENCX::S57CellIdentifier
	Identification of an S-57 cell. More...

class	ENCX::S57CellIdentifiers
	Collection of S57CellIdentifier. More...

class	ENCX::S57Colour
	An S-57 Colour Identifier. More...

class	ENCX::S57ColourValue
	An S-57 Colour Identifier combined with the values of the colour (RGB) for each colour scheme (Day, Twilight, Night). More...

class	ENCX::S57ColourValues
	A collection of S-57 colours and associated RGB values. More...

class	ENCX::S57ProductAndUsage
	The combination of an S-57 Product and an Intended Usage. More...

class	ENCX::S57ProductAndUsages
	Collection of S57ProductAndUsage. More...

class	ENCX::S57ObjectClass
	Type of S-57 Object. More...

class	ENCX::S57ObjectClassCollection
	Collection of S57ObjectClass. More...

class	ENCX::S57FeatureIdentifier
	A globally unique value that identifies a particular feature as represented by a particular S-57 cell. More...

class	ENCX::S57FeatureIdentifiers
	Collection of S57FeatureIdentifier. More...

class	ENCX::S57FeatureQuery
	A means of querying an S-57 cell within a SENC to obtain a collection of the cell's features. More...

class	ENCX::S57ManagerInitialisationData
	Parameters required to initialize S57Manager using OpenSenc2() More...

class	ENCX::S57Manager
	An S-57 SENC. More...

interface	ENCX::_IS57DrawEvents
	Events from S57Draw. More...

class	ENCX::S57Draw
	Display a continuous S-57 vector chart via a Win32 Device Context. More...

class	ENCX::HTMLGenerator
	Create HTML for display in a browser control (etc.) More...

class	ENCX::PixelPoint
	A value class representing a floating point Cartesian pixel point. More...

class	ENCX::PixelSize
	A value class representing a floating point Cartesian pixel size. More...

class	ENCX::PixelRect
	A value class representing a floating point Cartesian pixel rectangle aligned with the Cartesian axes. More...

Modules
library	ENCX
	An SDK for the display and use of marine navigational information supporting S-57/ENC and ARCS.

Enumerations
enum	DongleState { DS_NotFound , DS_Exists , DS_Active }
	The state of dongle. The dongle may either be DFS file (a 'virtual dongle') or a hardware dongle. More...

enum	PaletteType { PalDayBright , PalDay , PalDayBlack , PalDusk , PalNight , PalNightUnfiltered , PalCount , PalUnknown }
	Used to specify which palette the charts will be rendered in. More...

enum	GeoLineType { GL_GreatCircle , GL_Rhumb }
	The shape of the path between two points on the Earth's surface. More...

enum	S57Product { PD_Unknown = 0 , PD_ENC = 1 , PD_IENC = 10 , PD_PENC = 20 , PD_WVS = 25 , PD_MFF = 51 , PD_RAL = 52 , PD_LBO = 53 , PD_CLB = 54 , PD_ESB = 55 , PD_SBO = 56 , PD_AMLV3_GEN = 57 , PD_AMLV3_LND = 101 , PD_AMLV3_NCD = 102 , PD_AMLV3_SED = 103 , PD_AMLV3_CLB = 104 , PD_AMLV3_MMA = 105 , PD_AMLV3_MTD = 106 , PD_AMLV3_TSB = 107 , PD_AMLV3_FAI = 108 , PD_AMLV3_CFI = 109 , PD_AMLV3_MFI = 110 , PD_AMLV3_PEA = 111 , PD_AMLV3_QRT = 112 , PD_AMLV3_SBO = 113 , PD_AMLV3_LBO = 114 , PD_AMLV3_AMP = 115 , PD_AMLV3_ICE = 116 , PD_AMLV3_MNI = 117 , PD_AIO = 80 , PD_BENC = 200 }
	A number of 'products' use the S-57 vector chart standard. The most well known one is ENC (Electronic Navigational Chart). More...

enum	S57DepthDisplayUnits { DDU_Metres = 0 , DDU_Feet = 1 , DDU_MetresECDIS = 2 }
	Used for the display of soundings and contour depths on S57 charts. More...

enum	ScaleBarUnits { SBU_Kilometres = 0 , SBU_NauticalMiles = 1 }
	Used to set the units to use for the scale bar on S57 charts. More...

enum	SBDetailedMode { SDM_Off = 0 , SDM_Auto , SDM_UseMetres }
	Used to set the scale bar behaviour when the display scale is more detailed than 1:8,000. More...

enum	LatLonFormat { D_MM_SS_S = 0 , D_MM_SS_SS = 1 , D_MM_MMM = 2 , D_MM_MMMM = 3 , D_DDDDD = 4 , D_DDDDDD = 5 }
	Use this enum in GeoPointFormatter to change the lat-lon format returned by GeoPoint.FormattedPosition. More...

enum	S57FeatureGeometry { FG_None , FG_Point , FG_Line , FG_Area , FG_Sounding , FG_Unknown }
	S-57 supports a number of 'geometries', there are basically Points, Lines and Areas. More...

enum	S57CallBackDrawAction { CB_NoS57Layer , CB_BeforeS57Layer , CB_AfterS57Layer , CB_BeforeAndAfterS57Layer }
	Identifies the relationship between a drawing callback and the drawing of a particular layer. More...

enum	HTMLAction { SHA_DoNothing , SHA_MightBeUrl , SHA_GoHome , SHA_GoBack , SHA_GoForward , SHA_UpdatePages , SHA_UpdatePagesAndReloadCurrentPage , SHA_UpdatePagesAndGoHome }

enum	S57DisplayImprovements { S57DisplayImprovements_Nothing , S57DisplayImprovements_Max , S57DisplayImprovements_Level1 }

enum	S57Projection { S57Projection_Cylindrical , S57Projection_Mercator , S57Projection_PolarStereographic }

enum	S57DateMode { S57DateMode_UseSystemDate , S57DateMode_UseSetDate , S57DateMode_IgnoreDates }
	Determines the date to use when deciding whether to draw features with date dependencies or just allow all such features to be drawn by ignoring the date attributes. More...

enum	PenStyle { PS_Solid , PS_Dashed }
	Determines the style of pen to use for drawing grid lines. More...

enum	VPFFeatureType { FT_Node = 0 , FT_Text = 1 , FT_Edge = 2 , FT_Face = 3 }
	VPF feature types to draw. More...

enum	UniversalGridType { Grid_UTM = 0 , Grid_MGRS = 2 }

Detailed Description

ENCX Object Model

Definition in file encxcom.idl.

Enumeration Type Documentation

◆ DongleState

enum DongleState

The state of dongle. The dongle may either be DFS file (a 'virtual dongle') or a hardware dongle.

Enumerator
DS_NotFound	No dongle could be found (hardware dongles require drivers, software dongles require the DFS file to be in the right place)
DS_Exists	A dongle exists but is not licensing the product. This may be affected by the OEM key (or default) used.
DS_Active	Dongle found and working.

Definition at line 26 of file encxcom.idl.

◆ GeoLineType

enum GeoLineType

The shape of the path between two points on the Earth's surface.

Paths are described on the surface of the WGS-84 spheroid.

Lines in ENCX always take the shorter of the two possible routes round the globe. Therefore the change in longitude along the path of a line is always less than or equal to 180 degrees.

Enumerator
GL_GreatCircle	The shortest route between two points on the WGS-84 spheroid.
GL_Rhumb	The line of constant bearing between two points on the WGS-84 spheroid.

Definition at line 54 of file encxcom.idl.

◆ HTMLAction

enum HTMLAction

Enumerator
SHA_DoNothing	Do nothing.
SHA_MightBeUrl	Might be a URL.
SHA_GoHome	Go home.
SHA_GoBack	Go back.
SHA_GoForward	Go forward.
SHA_UpdatePages	Update pages.
SHA_UpdatePagesAndReloadCurrentPage	Update pages and reload the current page.
SHA_UpdatePagesAndGoHome	Update pages and go home.

Definition at line 152 of file encxcom.idl.

◆ LatLonFormat

enum LatLonFormat

Use this enum in GeoPointFormatter to change the lat-lon format returned by GeoPoint.FormattedPosition.

Note that when there is national or universal grid coverage (and it's turned on) then the LatLonFormat is not used

Enumerator
D_MM_SS_S	Degrees, minutes, seconds to 1 decimal place.
D_MM_SS_SS	Degrees, minutes, seconds to 2 decimal places.
D_MM_MMM	Degrees, minutes to 3 decimal places.
D_MM_MMMM	Degrees, minutes to 4 decimal places.
D_DDDDD	Degrees to 5 decimal places.
D_DDDDDD	Degrees to 6 decimal places.

Definition at line 121 of file encxcom.idl.

◆ PaletteType

enum PaletteType

Used to specify which palette the charts will be rendered in.

The idea is that users of a chart system switch it into a different mode at night so they can still see out of the windows of the ship. (Many just use the brightness control instead)

Enumerator
PalDayBright	Daytime palette for bright conditions.
PalDay	Normal daytime palette.
PalDayBlack	Daytime palette with a black background.
PalDusk	Palette for dawn and dusk.
PalNight	Palette for night viewing.
PalNightUnfiltered	Palette for night viewing through a neutral filter.
PalCount	Number of palette values.
PalUnknown	Unknown palette.

Definition at line 37 of file encxcom.idl.

◆ PenStyle

enum PenStyle

Determines the style of pen to use for drawing grid lines.

Enumerator
PS_Solid	Draw a solid line.
PS_Dashed	Draw a dashed line.

Definition at line 187 of file encxcom.idl.

◆ S57CallBackDrawAction

enum S57CallBackDrawAction

Identifies the relationship between a drawing callback and the drawing of a particular layer.

To obtain the normal behaviour of drawing the layer without a callback before or after, unregister the callback.

Enumerator
CB_NoS57Layer	Don't draw S-57 layer
CB_BeforeS57Layer	Before S-57 layer draw
CB_AfterS57Layer	After S-57 layer draw
CB_BeforeAndAfterS57Layer	Both before and after S-57 layer draw.

Definition at line 144 of file encxcom.idl.

◆ S57DateMode

enum S57DateMode

Determines the date to use when deciding whether to draw features with date dependencies or just allow all such features to be drawn by ignoring the date attributes.

Enumerator
S57DateMode_UseSystemDate	Use the current system date.
S57DateMode_UseSetDate	Use the user set date.
S57DateMode_IgnoreDates	Draw all features regardless of date.

Definition at line 179 of file encxcom.idl.

◆ S57DepthDisplayUnits

enum S57DepthDisplayUnits

Used for the display of soundings and contour depths on S57 charts.

Enumerator
DDU_Metres	Metres and decimetres.
DDU_Feet	Feet.
DDU_MetresECDIS	Display in ECDIS font and style.

Definition at line 97 of file encxcom.idl.

◆ S57DisplayImprovements

enum S57DisplayImprovements

Enumerator
S57DisplayImprovements_Nothing	No non-standard decluttering.
S57DisplayImprovements_Max	CherSoft's best ENC chart display improvements (non-standard)
S57DisplayImprovements_Level1	ENC display improvements Q1 2012.

Definition at line 164 of file encxcom.idl.

◆ S57FeatureGeometry

enum S57FeatureGeometry

S-57 supports a number of 'geometries', there are basically Points, Lines and Areas.

Enumerator
FG_None	E.g. a collection of other features, such as the anchors and buoys for a tanker mooring system.
FG_Point	An object that is mapped as a single point, such as a light (LIGHTS) or a buoy (BOYSPP).
FG_Line	An object that is mapped as a line (possibly containing many segments), such as a contour.
FG_Area	An object that is mapped as an area, such as some land (LNDARE) or an area of constant sea depth (DEPARE).
FG_Sounding	A collection of depth soundings.
FG_Unknown	Should not normally occur.

Definition at line 132 of file encxcom.idl.

◆ S57Product

enum S57Product

A number of 'products' use the S-57 vector chart standard. The most well known one is ENC (Electronic Navigational Chart).

Enumerator
PD_Unknown	Unknown product.
PD_ENC	ENC vector data.
PD_IENC	Inland ENC (IENC) vector data.
PD_PENC	Port ENC (PENC) vector data.
PD_WVS	The World Shoreline supplied with ENCX is another product of the S-57 standard.
PD_MFF	Marine Foundation and Facilities (AML)
PD_RAL	Routes, Areas and Limits (AML)
PD_LBO	Large Bottom Object (AML)
PD_CLB	Contour Line Bathymetry (AML)
PD_ESB	Environment, Seabed and Beach (AML)
PD_SBO	Small Bottom Objects (AML)
PD_AMLV3_GEN	AML Version 3 - generic.
PD_AMLV3_LND	AML Version 3 - Land Background Data.
PD_AMLV3_NCD	AML Version 3 - Nautical Chart Background Data.
PD_AMLV3_SED	AML Version 3 - Sediment.
PD_AMLV3_CLB	AML Version 3 - Contour Line Bathymetry.
PD_AMLV3_MMA	AML Version 3 - Marine Management Areas.
PD_AMLV3_MTD	AML Version 3 - Mine Tactical Data.
PD_AMLV3_TSB	AML Version 3 - Territorial Sea Boundaries.
PD_AMLV3_FAI	AML Version 3 - Flight Aeronautical Information.
PD_AMLV3_CFI	AML Version 3 - Civil Flight Information.
PD_AMLV3_MFI	AML Version 3 - Military Flight Information.
PD_AMLV3_PEA	AML Version 3 - Practice and Exercise Areas.
PD_AMLV3_QRT	AML Version 3 - Q - Routes.
PD_AMLV3_SBO	AML Version 3 - Small Bottom Objects.
PD_AMLV3_LBO	AML Version 3 - Large Bottom Objects.
PD_AMLV3_AMP	AML Version 3 - Amphibious Warfare Data.
PD_AMLV3_ICE	AML Version 3 - Ice Data.
PD_AMLV3_MNI	AML Version 3 - Military Nautical Information.
PD_AIO	UKHO Admiralty Information Overlay (AIO)
PD_BENC	Bathymetric ENC.

Definition at line 61 of file encxcom.idl.

◆ S57Projection

enum S57Projection

Enumerator
S57Projection_Cylindrical	Original ENCX S-57 projection for fastest drawing.
S57Projection_Mercator	Mercator.
S57Projection_PolarStereographic	Polar Stereographic.

Definition at line 171 of file encxcom.idl.

◆ SBDetailedMode

enum SBDetailedMode

Used to set the scale bar behaviour when the display scale is more detailed than 1:8,000.

Enumerator
SDM_Off	Don't use detailed mode (default)
SDM_Auto	In detailed mode, set the scale bar length to 0.1 M when scale bar units are nautical miles or 0.1 km when scale bar units are km.
SDM_UseMetres	In detailed mode, set the scale bar length to 100 m (regardless of scale bar units).

Definition at line 112 of file encxcom.idl.

◆ ScaleBarUnits

enum ScaleBarUnits

Used to set the units to use for the scale bar on S57 charts.

Enumerator
SBU_Kilometres	kilometres
SBU_NauticalMiles	nautical miles

Definition at line 105 of file encxcom.idl.

◆ UniversalGridType

enum UniversalGridType

Enumerator
Grid_UTM	Universal Transverse Mercator.
Grid_MGRS	Military Grid Reference System.

Definition at line 202 of file encxcom.idl.

◆ VPFFeatureType

enum VPFFeatureType

VPF feature types to draw.

Enumerator
FT_Node	Point features.
FT_Text	Text features.
FT_Edge	Line features.
FT_Face	Polygon features.

Definition at line 194 of file encxcom.idl.

Classes

Modules

Enumerations