NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Constants

Data Structures

struct  WorkspaceState
 Workspace states. More...
 

Enumerations

enum  WorkspacePropertyId {
  kWorkspaceProperty_GeodatabaseName = kRootCatGeodatabaseProperty_GeodatabaseName, kWorkspaceProperty_CompilationTime = kRootCatGeodatabaseProperty_CompilationTime, kWorkspaceProperty_Encryption = kRootCatGeodatabaseProperty_Encryption, kWorkspaceProperty_NavStick = kRootCatGeodatabaseProperty_NavStick,
  kWorkspaceProperty_ENCIssueDate = kRootCatGeodatabaseProperty_ENCIssueDate, kWorkspaceProperty_SencVersion = kRootCatGeodatabaseProperty_SencVersion, kWorkspaceProperty_Name, kWorkspaceProperty_Flags,
  kWorkspaceProperty_ValidThrough = kRootCatGeodatabaseProperty_ValidThrough, kWorkspaceProperty_SencDescription = kRootCatGeodatabaseProperty_SencDescription, kWorkspaceProperty_DatasetCacheMemorySizeLimit
}
 Workspace property enumeration. More...
 
enum  WorkspaceFlagsEnum { kWorkspaceFlag_Encrypted = 1, kWorkspaceFlag_Archived = 2 }
 Workspace flags. More...
 
enum  DatasetParameters {
  kDatasetParameter_PRSP, kDatasetParameter_MinScale, kDatasetParameter_MaxScale, kDatasetParameter_IgnorePermits,
  kDatasetParameter_DatasetNameContext, kDatasetParameter_DatasetNameContextFirstOccurrence, kDatasetParameter_ExcludePRSP, kDatasetParameter_IgnoreTerminatedFlag,
  kDatasetParameter_WX_ProductFilter, kDatasetParameter_WX_TimeFilter, kDatasetParameter_MU_ReturnManualUpdates, kDatasetParameter_OverlayType,
  kDatasetParameter_DID, kDatasetParameter_UseDatasetCoverage, kDatasetParameter_ProductSpecificationDescription, kDatasetParameter_InDatasetNameOrder,
  kDatasetParameter_IncludeDatasetIDs, kDatasetParameter_ExcludeDatasetIDs, kDatasetParameter_MU_ReturnUpdatedDatasets
}
 Dataset parameters of the dataset enumerator. More...
 
enum  CellActuality {
  kCellActuality_Unknown = 0, kCellActuality_UpToDate, kCellActuality_UpdateAvailable, kCellActuality_NewEditionAvailable,
  kCellActuality_Withdrawn
}
 Actuality status of an installed ENC cell relative to the data server product list (PRODUCTS.TXT dataset) stored in the same SENC. More...
 
enum  ValidationParameters { kValidationParameter_SelectiveValidation = 100, kValidationParameter_ValidateAll }
 Validation parameters. More...
 
enum  ValidationOperations { kValidationOperation_ValidateFeatureDatasets = 0 }
 Validation operations. More...
 
enum  ValidationContinueCancel { kValidation_Continue = 0, kValidation_Cancel }
 Validation operations. More...
 
enum  GroundingCheckAlertGroupProperties {
  kGroundingCheckAlertGroupProperty_ID = 1, kGroundingCheckAlertGroupProperty_Name = 2, kGroundingCheckAlertGroupProperty_ShortDescription = 3, kGroundingCheckAlertGroupProperty_FullDescription = 4,
  kGroundingCheckAlertGroupProperty_Category = 5, kGroundingCheckAlertGroupProperty_Priority = 6, kGroundingCheckAlertGroupProperty_IndicationID = 7
}
 Grounding check alert group properties. More...
 
enum  GroundingCheckAlertGroupCategories { kGroundingCheckAlertGroupCategory_Unknown = 0, kGroundingCheckAlertGroupCategory_A = 1, kGroundingCheckAlertGroupCategory_B = 2 }
 Grounding check alert group categories. More...
 
enum  GroundingCheckAlertGroupPriorities { kGroundingCheckAlertGroupPriority_Unknown = 0, kGroundingCheckAlertGroupPriority_Alarm = 1, kGroundingCheckAlertGroupPriority_Warning = 2 }
 Grounding check alert group priorities. More...
 
enum  GroundingCheckAlertsState { kGroundingCheckAlertsState_Unchecked = 0, kGroundingCheckAlertsState_PartiallyChecked = 1, kGroundingCheckAlertsState_Checked = 2 }
 Grounding check alert group states. More...
 
enum  GroundingCheckAlertsIndication { kGroundingCheckAlertsIndicationID_NoIndication = 0, kGroundingCheckAlertsIndicationID_NavigationalHazards = 1, kGroundingCheckAlertsIndicationID_AreasWithSpecialConditions = 2, kGroundingCheckAlertsIndicationID_SafetyContour = 3 }
 Grounding check alert group indications. More...
 

Variables

static const SDKUInt32 WorkspaceStateBit_Modifying = 0x1
 Indicates that a workspace is in the modifying state.
 

Detailed Description

Enumeration Type Documentation

◆ WorkspacePropertyId

Workspace property enumeration.

Enumerator
kWorkspaceProperty_GeodatabaseName 

Geodatabase Name of a workspace.

kWorkspaceProperty_CompilationTime 

Geodatabase compilation time.

kWorkspaceProperty_Encryption 

Encryption type.

kWorkspaceProperty_NavStick 

Indicates whether a geodatabase was compiled from NAVTOR NavStick.

kWorkspaceProperty_ENCIssueDate 

Last compiled ENC database issue date.

kWorkspaceProperty_SencVersion 

SENC database version.

kWorkspaceProperty_Name 

Name of a workspace.

kWorkspaceProperty_Flags 

Flags of the workspace.

kWorkspaceProperty_ValidThrough 

SENC valid through.

kWorkspaceProperty_SencDescription 

SENC description.

kWorkspaceProperty_DatasetCacheMemorySizeLimit 

Memory size limit of the dataset cache.

◆ WorkspaceFlagsEnum

Workspace flags.

Enumerator
kWorkspaceFlag_Encrypted 

Indicates that the workspace contains some encrypted datasets.

kWorkspaceFlag_Archived 

Indicates that the workspace contains some archived datasets.

◆ DatasetParameters

Dataset parameters of the dataset enumerator.

Enumerator
kDatasetParameter_PRSP 

Dataset PRSP or list of PRSPs.

kDatasetParameter_MinScale 

Dataset minimum display scale.

kDatasetParameter_MaxScale 

Dataset maximum display scale.

kDatasetParameter_IgnorePermits 

Suppress to check permits.

kDatasetParameter_DatasetNameContext 

Can be used for context search.

kDatasetParameter_DatasetNameContextFirstOccurrence 

Returns only first occurrence.

kDatasetParameter_ExcludePRSP 

Exclude Dataset PRSP or list of PRSPs.

kDatasetParameter_IgnoreTerminatedFlag 

Ignore terminated flag.

kDatasetParameter_WX_ProductFilter 

specifies the WX product filter

kDatasetParameter_WX_TimeFilter 

specifies the WX time filter

kDatasetParameter_MU_ReturnManualUpdates 

return manual updates datasets only

kDatasetParameter_OverlayType 

Overlay type filter.

kDatasetParameter_DID 

DatasetID filter.

kDatasetParameter_UseDatasetCoverage 

It could be a slow operation, use with care.

kDatasetParameter_ProductSpecificationDescription 

Product specification description filter (string).

kDatasetParameter_InDatasetNameOrder 

Return datasets in the dataset name order.

kDatasetParameter_IncludeDatasetIDs 

Include Dataset IDs. List of dataset IDs.

kDatasetParameter_ExcludeDatasetIDs 

Exclude Dataset IDs. List of dataset IDs.

kDatasetParameter_MU_ReturnUpdatedDatasets 

return manually updated datasets

◆ CellActuality

Actuality status of an installed ENC cell relative to the data server product list (PRODUCTS.TXT dataset) stored in the same SENC.

The status is a fail-safe value: the enumeration starts from kCellActuality_Unknown, and the status stays Unknown whenever SDK can not positively confirm, that the installed cell is up to date. Consumers must never treat kCellActuality_Unknown as "up to date".

Enumerator
kCellActuality_Unknown 

Actuality can not be determined. It does not mean, that the cell is up to date. See IWorkspace::GetCellActuality.

kCellActuality_UpToDate 

The installed cell edition and update number are not behind the data server product list.

kCellActuality_UpdateAvailable 

A newer update of the same base edition is available.

kCellActuality_NewEditionAvailable 

A newer base edition is available.

kCellActuality_Withdrawn 

The cell is terminated (withdrawn from the service) or cancelled.

◆ ValidationParameters

Validation parameters.

Enumerator
kValidationParameter_SelectiveValidation 

Validates randomly selected objects.
This parameter is a selection mask in SDKUint8, zero bit indicates the dataset to be skipped in the shuffled sequence. This parameter is used to speed up validation.

kValidationParameter_ValidateAll 

If this parameter is set, the validation does not stop on the first invalid object.

◆ ValidationOperations

Validation operations.

Enumerator
kValidationOperation_ValidateFeatureDatasets 

Validating of the feature datasets.

◆ ValidationContinueCancel

Validation operations.

Enumerator
kValidation_Continue 

Continue the validation.

kValidation_Cancel 

Cancel the validation.

◆ GroundingCheckAlertGroupProperties

Grounding check alert group properties.

Enumerator
kGroundingCheckAlertGroupProperty_ID 

Unique integer identifier.

kGroundingCheckAlertGroupProperty_Name 

Full name of the alert group.

kGroundingCheckAlertGroupProperty_ShortDescription 

Short description of the alert group.

kGroundingCheckAlertGroupProperty_FullDescription 

Optional full description of the alert group.

kGroundingCheckAlertGroupProperty_Category 

Alert group category - GroundingCheckAlertGroupCategories.

kGroundingCheckAlertGroupProperty_Priority 

Alert group priority - GroundingCheckAlertGroupPriorities.

kGroundingCheckAlertGroupProperty_IndicationID 

Alert group indication id - GroundingCheckAlertsIndication.

◆ GroundingCheckAlertGroupCategories

Grounding check alert group categories.

Enumerator
kGroundingCheckAlertGroupCategory_Unknown 

Unknown alert group category.

kGroundingCheckAlertGroupCategory_A 

Alert group category A.

kGroundingCheckAlertGroupCategory_B 

Alert group category B.

◆ GroundingCheckAlertGroupPriorities

Grounding check alert group priorities.

Enumerator
kGroundingCheckAlertGroupPriority_Unknown 

Unknown alert group priority.

kGroundingCheckAlertGroupPriority_Alarm 

Alert group priority - Alarm.

kGroundingCheckAlertGroupPriority_Warning 

Alert group priority - Warning.

◆ GroundingCheckAlertsState

Grounding check alert group states.

Enumerator
kGroundingCheckAlertsState_Unchecked 

Alert group is unchecked.

kGroundingCheckAlertsState_PartiallyChecked 

Alert group is partly checked. Some subgroups are checked.

kGroundingCheckAlertsState_Checked 

Alert group is checked. All subgroups are checked.

◆ GroundingCheckAlertsIndication

Grounding check alert group indications.

Enumerator
kGroundingCheckAlertsIndicationID_NoIndication 

Indication does not exist.

kGroundingCheckAlertsIndicationID_NavigationalHazards 

Navigational hazards indication.

kGroundingCheckAlertsIndicationID_AreasWithSpecialConditions 

Areas for which Special Conditions exist indication.

kGroundingCheckAlertsIndicationID_SafetyContour 

Safety contour indication.