ENCX SDK  5.5.0.370
Public Member Functions | Properties | List of all members
IS57FeatureIdentifier Interface Reference

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

import"encxcom.idl";

Inheritance diagram for IS57FeatureIdentifier:
Inheritance graph
[legend]

Public Member Functions

HRESULT ToString ([out, retval] BSTR *pVal)
 Obtain a string representation of the identifier. More...
 
HRESULT Construct ([in] SHORT Agency, [in] LONG FIDN, [in] SHORT FIDS, [in] IS57CellIdentifier *piCellID)
 Compose from parts. More...
 
HRESULT FromString ([in] BSTR val)
 Construct from string. More...
 
HRESULT ConstructEx ([in] SHORT Agency, [in] LONG FIDN, [in] SHORT FIDS, [in] IS57CellIdentifier *piCellID, [in] LONG index)
 Compose from parts including index. More...
 
HRESULT ToStringEx ([out, retval] BSTR *pVal)
 Obtain a string representation of the identifier. More...
 

Properties

SHORT Agency [get]
 Per provider identifier of a particular feature in a particular cell. 1:1 correspondence with the Agency description in IS57CellInfo::Agency. More...
 
LONG FIDN [get]
 The combination of FIDN and FIDS (usually) uniquely identifies an S-57 feature within a particular S-57 data provider. More...
 
SHORT FIDS [get]
 The combination of FIDN and FIDS (usually) uniquely identifies an S-57 feature within a particular S-57 data provider. More...
 
IS57CellIdentifier CellIdentifier [get]
 The same feature can occur in multiple cells (e.g. if a line or area straddles a cell boundary). More...
 
LONG Index [get]
 In some cells, the same identifier is used for multiple features. Index can be used to differentiate them. More...
 

Detailed Description

Properties and methods for ENCX::S57FeatureIdentifier.

Definition at line 2446 of file encxcom.idl.

Member Function Documentation

◆ Construct()

HRESULT IS57FeatureIdentifier::Construct ( [in] SHORT  Agency,
[in] LONG  FIDN,
[in] SHORT  FIDS,
[in] IS57CellIdentifier piCellID 
)

Compose from parts.

◆ ConstructEx()

HRESULT IS57FeatureIdentifier::ConstructEx ( [in] SHORT  Agency,
[in] LONG  FIDN,
[in] SHORT  FIDS,
[in] IS57CellIdentifier piCellID,
[in] LONG  index 
)

Compose from parts including index.

◆ FromString()

HRESULT IS57FeatureIdentifier::FromString ( [in] BSTR  val)

Construct from string.

◆ ToString()

HRESULT IS57FeatureIdentifier::ToString ( [out, retval] BSTR *  pVal)

Obtain a string representation of the identifier.

◆ ToStringEx()

HRESULT IS57FeatureIdentifier::ToStringEx ( [out, retval] BSTR *  pVal)

Obtain a string representation of the identifier.

Property Documentation

◆ Agency

SHORT IS57FeatureIdentifier::Agency
get

Per provider identifier of a particular feature in a particular cell. 1:1 correspondence with the Agency description in IS57CellInfo::Agency.

Each S-57 data provider has a unique identifier, presented a two character string and as a number.

E.g. "GB", 540 is United Kingdom Hydrographic Office.

E.g. "9A", 39578 is CherSoft Ltd.

The full table of values can be obtained from http://www.openecdis.org S-57 Producer (Agency) Codes.

◆ CellIdentifier

IS57CellIdentifier IS57FeatureIdentifier::CellIdentifier
get

The same feature can occur in multiple cells (e.g. if a line or area straddles a cell boundary).

◆ FIDN

LONG IS57FeatureIdentifier::FIDN
get

The combination of FIDN and FIDS (usually) uniquely identifies an S-57 feature within a particular S-57 data provider.

◆ FIDS

SHORT IS57FeatureIdentifier::FIDS
get

The combination of FIDN and FIDS (usually) uniquely identifies an S-57 feature within a particular S-57 data provider.

◆ Index

LONG IS57FeatureIdentifier::Index
get

In some cells, the same identifier is used for multiple features. Index can be used to differentiate them.