An S-57 SENC. More...

import"encxcom.idl";

Inheritance diagram for ENCX::S57Manager:

Public Member Functions
HRESULT	OpenSenc ([in] ILibrary *EncXLibrary, [in] BSTR sSencFolder)
	Associate this manager with a specified folder. More...

HRESULT	CloseSenc (void)
	Dissociate from the current folder. More...

HRESULT	Cells ([in] IS57ProductAndUsages ProductAndUsages, [in] IGeoRect cr, [out, retval] IS57CellIdentifiers **pVal)
	Obtain the collection of all the cells in this SENC. More...

HRESULT	CellInfo ([in] IS57CellIdentifier piCellID, [out, retval] IS57CellInfo *pVal)
	Obtain the details for a specified S-57 cell. More...

HRESULT	ObjectClass ([in] IS57FeatureIdentifier fid, [out, retval] IS57ObjectClass *pVal)
	Obtain the type (ObjectClass in S-57 language) of a specified S-57 feature. More...

HRESULT	Geometry ([in] IS57FeatureIdentifier pifid, [out, retval] enum S57FeatureGeometry pVal)
	Obtain the geometry of a specified S-57 feature. More...

HRESULT	FeatureInfo ([in] IS57FeatureIdentifier pifid, [out, retval] IS57FeatureInfo *pVal)
	Obtain the general details for a specified S-57 feature. More...

HRESULT	FeatureInfoPoint ([in] IS57FeatureIdentifier pifid, [out, retval] IS57FeaturePoint *pVal)
	Obtain the general details and spatial details (a single geographical position) for a specified S-57 Point feature. More...

HRESULT	FeatureInfoLine ([in] IS57FeatureIdentifier pifid, [out, retval] IS57FeatureLine *pVal)
	Obtain the general details and spatial details (a chain of geographical positions) for a specified S-57 Line feature. More...

HRESULT	FeatureInfoArea ([in] IS57FeatureIdentifier pifid, [out, retval] IS57FeatureArea *pVal)
	Obtain the general details and spatial details (one or more rings of geographical positions) for a specified S-57 Area feature. More...

HRESULT	FeatureInfoSounding ([in] IS57FeatureIdentifier pifid, [out, retval] IS57FeatureSounding *pVal)
	Obtain the general details and spatial details (one or more point geographical positions) for a specified S-57 Sounding feature. More...

HRESULT	RunInstallApplication ([in] BSTR pathToApplication)
	Invoke the CherSoft Windows application that installs and updates ENC cells in the SENC. More...

HRESULT	OpenSenc2 ([in] ILibrary EncXLibrary, [in] IS57ManagerInitialisationData p)
	Associate this manager with a specified folder. More...

HRESULT	OpenSencAndWVS ([in] ILibrary *EncXLibrary, [in] BSTR sSencFolder, [in] BSTR sWVSFileOrFolder)
	Open ENC SENC and World Vector Shoreline .cvcf file or WVS SENC folder. More...

HRESULT	UserPermit ([out, retval] BSTR *pUserPermit)
	The ENC user permit needed to buy commercial ENC chart data. More...

HRESULT	IsValidSencFolder ([in] BSTR sPath, [out, retval] VARIANT_BOOL *bRes)
	Is the path pointing to a valid SENC. A SENC is the folder structure in which ENC chart data is installed. More...

HRESULT	CreateSencFolder ([in] BSTR sPath)
	Create a SENC. A SENC is the folder structure in which ENC chart data is installed. More...

Properties
IS57CellIdentifiers	UnusedCells `[get]`
	Obtain a collection of the cells in the Senc that cannot be used. These cells need to be re-installed. More...

IS57ProductAndUsages	InstalledProducts `[get]`
	Obtain the collection of S-57 products currently present in this SENC. More...

Detailed Description

An S-57 SENC.

An S-57 Manager provides access to a System Electronic Navigational Chart (SENC), which comprises a collection of S-57 cells.

Each cell contains the chart information for a bounded area for a particular navigational purpose. Cells are limited in size, so large numbers of cells are required to cover a large area at a detailed scale.

Cells are added to the SENC and updated using ManageENC.exe which is invoked directly or via its COM interface. This does everything necessary to install and update all the cells from an S-57 data provider's CD into the SENC.

The SENC can be used to draw S-57 data onto a window or bitmap drawing surface using S57Draw.

Properties and methods via IS57Manager.

Definition at line 4319 of file encxcom.idl.

Member Function Documentation

◆ CellInfo()

HRESULT IS57Manager::CellInfo	(	[in] IS57CellIdentifier *	piCellID,
		[out, retval] IS57CellInfo **	pVal
	)

inherited

Obtain the details for a specified S-57 cell.

◆ Cells()

HRESULT IS57Manager::Cells	(	[in] IS57ProductAndUsages *	ProductAndUsages,
		[in] IGeoRect *	cr,
		[out, retval] IS57CellIdentifiers **	pVal
	)

inherited

Obtain the collection of all the cells in this SENC.

A snapshot of the installed cells at the time when this property is requested. It will not stay up to date as new cells are installed. To keep up to date you should observe the OnBusy(..) events.

◆ CloseSenc()

HRESULT IS57Manager::CloseSenc ( void )

inherited

Dissociate from the current folder.

◆ CreateSencFolder()

HRESULT IS57Manager::CreateSencFolder ( [in] BSTR sPath )

inherited

Create a SENC. A SENC is the folder structure in which ENC chart data is installed.

◆ FeatureInfo()

HRESULT IS57Manager::FeatureInfo	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] IS57FeatureInfo **	pVal
	)

inherited

Obtain the general details for a specified S-57 feature.

This method can be used with a feature of any Geometry.

◆ FeatureInfoArea()

HRESULT IS57Manager::FeatureInfoArea	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] IS57FeatureArea **	pVal
	)

inherited

Obtain the general details and spatial details (one or more rings of geographical positions) for a specified S-57 Area feature.

This method will only succeed for a feature of ENCX::FG_Area Geometry.

◆ FeatureInfoLine()

HRESULT IS57Manager::FeatureInfoLine	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] IS57FeatureLine **	pVal
	)

inherited

Obtain the general details and spatial details (a chain of geographical positions) for a specified S-57 Line feature.

This method will only succeed for a feature of ENCX::FG_Line Geometry.

◆ FeatureInfoPoint()

HRESULT IS57Manager::FeatureInfoPoint	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] IS57FeaturePoint **	pVal
	)

inherited

Obtain the general details and spatial details (a single geographical position) for a specified S-57 Point feature.

This method will only succeed for a feature of ENCX::FG_Point Geometry.

◆ FeatureInfoSounding()

HRESULT IS57Manager::FeatureInfoSounding	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] IS57FeatureSounding **	pVal
	)

inherited

Obtain the general details and spatial details (one or more point geographical positions) for a specified S-57 Sounding feature.

This method will only succeed for a feature of ENCX::FG_Sounding Geometry.

ENCX::FG_Sounding is used as a more efficient way of encoding large numbers of soundings. It is very similar to a correspondingly larger number Point features all with identical attributes and attribute values.

◆ Geometry()

HRESULT IS57Manager::Geometry	(	[in] IS57FeatureIdentifier *	pifid,
		[out, retval] enum S57FeatureGeometry *	pVal
	)

inherited

Obtain the geometry of a specified S-57 feature.

◆ IsValidSencFolder()

HRESULT IS57Manager::IsValidSencFolder	(	[in] BSTR	sPath,
		[out, retval] VARIANT_BOOL *	bRes
	)

inherited

Is the path pointing to a valid SENC. A SENC is the folder structure in which ENC chart data is installed.

◆ ObjectClass()

HRESULT IS57Manager::ObjectClass	(	[in] IS57FeatureIdentifier *	fid,
		[out, retval] IS57ObjectClass **	pVal
	)

inherited

Obtain the type (ObjectClass in S-57 language) of a specified S-57 feature.

◆ OpenSenc()

HRESULT IS57Manager::OpenSenc	(	[in] ILibrary *	EncXLibrary,
		[in] BSTR	sSencFolder
	)

inherited

Associate this manager with a specified folder.

◆ OpenSenc2()

HRESULT IS57Manager::OpenSenc2	(	[in] ILibrary *	EncXLibrary,
		[in] IS57ManagerInitialisationData *	p
	)

inherited

Associate this manager with a specified folder.

◆ OpenSencAndWVS()

HRESULT IS57Manager::OpenSencAndWVS	(	[in] ILibrary *	EncXLibrary,
		[in] BSTR	sSencFolder,
		[in] BSTR	sWVSFileOrFolder
	)

inherited

Open ENC SENC and World Vector Shoreline .cvcf file or WVS SENC folder.

◆ RunInstallApplication()

HRESULT IS57Manager::RunInstallApplication ( [in] BSTR pathToApplication )

inherited

Invoke the CherSoft Windows application that installs and updates ENC cells in the SENC.

◆ UserPermit()

HRESULT IS57Manager::UserPermit ( [out, retval] BSTR * pUserPermit )

inherited

The ENC user permit needed to buy commercial ENC chart data.

Property Documentation

◆ InstalledProducts

IS57ProductAndUsages IS57Manager::InstalledProducts

getinherited

Obtain the collection of S-57 products currently present in this SENC.

A snapshot of the products at the time when this property is requested. It will not stay up to date.

◆ UnusedCells

IS57CellIdentifiers IS57Manager::UnusedCells

getinherited

Obtain a collection of the cells in the Senc that cannot be used. These cells need to be re-installed.

The result returned is a snapshot of the unused cells at the time when the property is requested. It will not stay up to date.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CellInfo()

◆ Cells()

◆ CloseSenc()

◆ CreateSencFolder()

◆ FeatureInfo()

◆ FeatureInfoArea()

◆ FeatureInfoLine()

◆ FeatureInfoPoint()

◆ FeatureInfoSounding()

◆ Geometry()

◆ IsValidSencFolder()

◆ ObjectClass()

◆ OpenSenc()

◆ OpenSenc2()

◆ OpenSencAndWVS()

◆ RunInstallApplication()

◆ UserPermit()

Property Documentation

◆ InstalledProducts

◆ UnusedCells