_encxcom_encx.idl File Reference

ENCX Object Model More...

Go to the source code of this file.

Namespaces
namespace	ENCX
Classes
interface	IDongle
	A security device. More...
interface	IDongleObserver
	Properties and methods for ENCX::DongleObserver. 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 identfiers. 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 hittesting a S57Draw object. More...
interface	IS57DrawnFeatures
	A collection of features returned by hittesting an S57Draw object. More...
interface	IS57DisplaySettings
	Properties and methods for ENCX::S57DisplaySettings. 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	IS57Draw
	Properties and methods for ENCX::S57Draw. More...
interface	IHTMLGenerator
	Properties and methods for ENCX::HTMLGenerator. 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. 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...
interface	ENCX::_IRasDrawEvents
	Events from RasDraw. 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 feaure as represneted 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...
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_WVS = 25 }
	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 }
	Used for the display of soundings and contour depths on S57 charts. 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 }

---

Detailed Description

ENCX Object Model

Definition in file _encxcom_encx.idl.

---

Enumeration Type Documentation

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 22 of file _encxcom_encx.idl.

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 51 of file _encxcom_encx.idl.

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 94 of file _encxcom_encx.idl.

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 palete values.
PalUnknown	Unknown palette.

Definition at line 34 of file _encxcom_encx.idl.

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 86 of file _encxcom_encx.idl.

enum S57DepthDisplayUnits

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

Enumerator:

DDU_Metres	Metres and decimetres.
DDU_Feet	Feet.

Definition at line 67 of file _encxcom_encx.idl.

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 106 of file _encxcom_encx.idl.

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 74 of file _encxcom_encx.idl.

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_WVS	The World Shoreline supplied with ENCX is another product of the S-57 standard.

Definition at line 58 of file _encxcom_encx.idl.