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

Describes interfaces that manages a geodatabase dataset object. More...

#include <base/inc/sdk_any_handler.h>
#include <base/inc/units/units_const.h>
#include <datalayer/inc/geodatabase/gdb_stream.h>
#include <datalayer/inc/geodatabase/gdb_const.h>
#include <datalayer/inc/geodatabase/gdb_attribute.h>
#include <datalayer/inc/senc/senc_feature_dataset_s101.h>

Go to the source code of this file.

Data Structures

class  IDataset
 Provides access to members that supply dataset information. More...
 
class  IFeatureDataset
 Provides access to members that supply feature dataset information. A FeatureDataset is a dataset that contains features that share the same spatial reference as the Feature Dataset. More...
 
class  IEnumFeature
 Enumerates the features. More...
 
class  IFeatureCollection
 Collection of features. More...
 
class  IFeatureFilter
 Feature filter. More...
 
class  IFeatureAttributesFilter
 Feature attributes filter. More...
 

Macros

#define DatasetNameLen   16
 The dataset id type definition.
 

Enumerations

enum  DatasetType {
  kDT_Any = 0, kDT_FeatureDataset = 1, kDT_UpdateHistory = 2, kDT_FeatureCatalog = 3,
  kDT_Portrayal = 4, kDT_Coverage = 5, kDT_SpatialIndex = 6, kDT_Raster = 7,
  kDT_XML = 8, kDT_XSLT = 9, kDT_Text = 10, kDT_HTML = 11,
  kDT_Multimedia = 12, kDT_RootCatalog = 13, kDT_DatasetCatalog = 14, kDT_DatasetCatalogSpatialIndex = 15,
  kDT_CoverageCatalog = 16, kDT_CRS = 17, kDT_S63Permit = 18, kDT_DataProducerCodesCatalog = 19,
  kDT_Rules = 20, kDT_IndexDataset = 21
}
 The dataset type definition. More...
 
enum  DatasetSpecificUsage { kDSPSU_Unspecified = 0, kDSPSU_PortEntry, kDSPSU_Transit, kDSPSU_Overview }
 The type of the dataset specific usage. More...
 
enum  DatasetClassificationLevel {
  kDSPC_Unspecified = 0, kDSPC_Unclassified, kDSPC_Restricted, kDSPC_Confidential,
  kDSPC_Secret, kDSPC_TopSecret
}
 The type of the dataset classification level. More...
 
enum  DatasetLayering { kDSPLID_Undefined = 0, kDSPLID_ScaleIndependent, kDSPLID_ScaleDependent, kDSPLID_Complete }
 Identifies the relationship to other layers. More...
 
enum  DatasetProfile {
  kDSPROF_Undefined = 0 , kDSPROF_NonIntegratedUpdate = 128, kDSPROF_MarinerObjects = 130, kDSPROF_DatasetCoverageCatalog = 131,
  kDSPROF_UserObjects = 132, kDSPROF_ProductsFile = 133, kDSPROF_MediaInfoFile = 134
}
 
enum  DatasetOverlayType { , kDSOT_BasicOverlay, kDSOT_FreeOverlay, kDSOT_SpecificOverlay, kDSOT_InlandENC_FreeOverlay_Indicator = 0x80 }
 Defines the dataset overlay type. More...
 
enum  DatasetProperty {
  kDSP_FileName = senc::kDSPR_S57_DSID_DSNM, kDSP_EditionNumber = senc::kDSPR_S57_DSID_EDTN, kDSP_UpdateNumber = senc::kDSPR_S57_DSID_UPDN, kDSP_UpdateApplicationDate = senc::kDSPR_S57_DSID_UADT,
  kDSP_IssueDate = senc::kDSPR_S57_DSID_ISDT, kDSP_IntendedUsage = senc::kDSPR_S57_DSID_INTU , kDSP_PRSP = senc::kDSPR_S57_DSID_PRSP, kDSP_ProducingAgency = senc::kDSPR_S57_DSID_AGEN,
  kDSP_CompilationScale = senc::kDSPR_S57_DSPM_CSCL, kDSP_DS_SW_LAT = senc::kDSPR_S57_DS_SW_LAT, kDSP_DS_SW_LON = senc::kDSPR_S57_DS_SW_LON, kDSP_DS_NE_LAT = senc::kDSPR_S57_DS_NE_LAT,
  kDSP_DS_NE_LON = senc::kDSPR_S57_DS_NE_LON, kDSP_Comment = senc::kDSPR_S57_DSID_COMT, kDSP_Encryption = senc::kDSPR_S57_DSID_ENCA , kDSP_NewEditionAvailable = senc::kDSPR_S57_DS_NEW_EDITION,
  kDSP_Profile = senc::kDSPR_S57_DSID_PROF , kDSP_ProductSpecificationDescription = senc::kDSPR_S57_DSID_PSDN, kDSP_SpecificUsage = senc::kDSPR_MAX_PROP_CODE + 1, kDSP_OptDispScale,
  kDSP_MinDispScale, kDSP_MaxDispScale, kDSP_Layering, kDSP_DatasetOverlayType,
  kDSP_Description, kDSP_Classification, kDSP_OfficialStatus, kDSP_Volatile,
  kDSP_HasFlashingObjects, kDSP_BrowseName, kDSP_DataserverID, kDSP_PermitExpirationDate,
  kDSP_FormatVersion, kDSP_CRC, kDSP_Units_Velocity, kDSP_Units_Distance,
  kDSP_DatasetRevisionCounter, kDSP_DatasetUID, kDSP_DictionaryVersion, kDSP_Units_Pressure,
  kDSP_Units_Period, kDSP_Units_Direction, kDSP_Flags, kDSP_Units_Temperature,
  kDSP_Units_Precipitation , kDSP_User = 1000
}
 Dataset properties. More...
 
enum  GetFeaturesParameter {
  kGetFeaturesParameter_Flags, kGetFeaturesParameter_SkipFeatures, kGetFeaturesParameter_IncludeFeatureClasses, kGetFeaturesParameter_ExcludeFeatureClasses,
  kGetFeaturesParameter_IncludeAttributeClasses, kGetFeaturesParameter_ExcludeAttributeClasses, kGetFeaturesParameter_GeometryMask, kGetFeaturesParameter_IncludeAttributeClassesAndValues,
  kGetFeaturesParameter_ExcludeAttributeClassesAndValues, kGetFeaturesParameter_IncludeFOIDs, kGetFeaturesParameter_ExcludeFOIDs, kGetFeaturesParameter_WX_ProductFilter,
  kGetFeaturesParameter_GroundingCheck_SafetyHeight, kGetFeaturesParameter_GroundingCheck_SafetyDepth, kGetFeaturesParameter_GroundingCheck_SafetyContour, kGetFeaturesParameter_GroundingCheck_GetDatasetsParameters,
  kGetFeaturesParameter_GroundingCheck_GetFeaturesParameters, kGetFeaturesParameter_GroundingCheck_SkipLUTTest, kGetFeaturesParameter_GroundingCheck_SkipAreaTest, kGetFeaturesParameter_GroundingCheck_IncludeOnlySafetyContourObjects,
  kGetFeaturesParameter_GroundingCheck_ExcludeSafetyContourObjects, kGetFeaturesParameter_GroundingCheck_UsePeriodicAttributes, kGetFeaturesParameter_GroundingCheck_TimeLimitedObjectsCurrentTime, kGetFeaturesParameter_GroundingCheck_TimeLimitedObjectsStartTime,
  kGetFeaturesParameter_GroundingCheck_TimeLimitedObjectsEndTime, kGetFeaturesParameter_GroundingCheck_DataSelection_Projection, kGetFeaturesParameter_GroundingCheck_DataSelection_AreaSize, kGetFeaturesParameter_GroundingCheck_DataSelection_Algorithm,
  kGetFeaturesParameter_GroundingCheck_LookupCacheMaxSize, kGetFeaturesParameter_GroundingCheck_DoNotUseAIOEncaff, kGetFeaturesParameter_GroundingCheck_ExcludeOverview, kGetFeaturesParameter_GroundingCheck_TreatAsMultigeometry,
  kGetFeaturesParameter_GroundingCheck_DangersCountLimit, kGetFeaturesParameter_GroundingCheck_CautionsCountLimit, kGetFeaturesParameter_GroundingCheck_AllowEmptyGeometry, kGetFeaturesParameter_GroundingCheck_UseSafetyHeight,
  kGetFeaturesParameter_MU_DeltaTimeLimitToSkipManualUpdates, kGetFeaturesParameter_IncludeDatasetID, kGetFeaturesParameter_DisplayScale, kGetFeaturesParameter_Tides_DateStart,
  kGetFeaturesParameter_Tides_DateEnd, kGetFeaturesParameter_SearchMask, kGetFeaturesParameter_ADP_GetAreas, kGetFeaturesParameter_ADP_GetFeaturesByArea,
  kGetFeaturesParameter_ADP_GetLicenseAreas, kGetFeaturesParameter_Tides_DaylightSavingHours, kGetFeaturesParameter_IncludePRSP, kGetFeaturesParameter_Synchronously,
  kGetFeaturesParameter_GroundingCheck_SplitGeometryStepM
}
 Parameters that control the feature enumeration. More...
 
enum  GroundingCheckDataSelectionAlgorithm { kGroundingCheckDataSelectionAlgorithm_LargeScalePriority, kGroundingCheckDataSelectionAlgorithm_ENCPriority }
 Algorithm for datasets selecting. More...
 
enum  GetFeaturesFlags {
  kGetFeaturesFlags_Null = 0, kGetFeaturesFlags_MastersOnly = 1, kGetFeaturesFlags_HazardsOnly = 2, kGetFeaturesFlags_GroundingCheck = 4,
  kGetFeaturesFlags_GroundingCheckAsync = 8, kGetFeaturesFlags_WX_ReturnGridVertices = 16, kGetFeaturesFlags_WX_ReturnClosestGridVertice = 32, kGetFeaturesFlags_MU_ReturnInvisibleManualUpdates = 64,
  kGetFeaturesFlags_MU_ReturnManualUpdates = 128, kGetFeaturesFlags_MU_SkipManualUpdates = 256, kGetFeaturesFlags_IntersectFeatureGeometry = 512 , kGetFeaturesFlags_ReturnInvisibleFeatures = kGetFeaturesFlags_MU_ReturnInvisibleManualUpdates
}
 Mask for the kGetFeaturesParameter_Flags. More...
 
enum  GetDatasetObjectParameter { kGetDatasetObjectParameter_Flags }
 Parameters for the GetDatasetObject. More...
 
enum  DatasetVelocityUnits { kDatasetVelocityUnits_MetersPerSecond, kDatasetVelocityUnits_Knots, kDatasetVelocityUnits_CentimetersPerSecond }
 Velocity units values. More...
 
enum  DatasetDistanceUnits { kDatasetDistanceUnits_Meters, kDatasetDistanceUnits_Kilometers, kDatasetDistanceUnits_NM }
 Distance units values. More...
 
enum  DatasetPressureUnits { kDatasetPressureUnits_Pa, kDatasetPressureUnits_hPa, kDatasetPressureUnits_kPa }
 Pressure units values. More...
 
enum  DatasetPeriodUnits { kDatasetPeriodUnits_Seconds, kDatasetPeriodUnits_Minutes, kDatasetPeriodUnits_Hours }
 Period units values. More...
 
enum  DatasetDirectionUnits { kDatasetDirectionUnits_Degrees }
 Direction units values. More...
 
enum  tagCheckFeatureResult { CheckFeatureResult_Stop = 0, CheckFeatureResult_Skip, CheckFeatureResult_Ok }
 Fired during constructing of the feature enumeration. More...
 

Detailed Description

Describes interfaces that manages a geodatabase dataset object.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author
The NAVTOR SDK authors
Date
08/2011
Maintenance:
The NAVTOR SDK authors

Enumeration Type Documentation

◆ DatasetProfile

Enumerator
kDSPROF_Undefined 

base dataset

kDSPROF_NonIntegratedUpdate 

Non integrated update.

kDSPROF_MarinerObjects 

Mariner Objects.

kDSPROF_DatasetCoverageCatalog 

Dataset Coverage Catalog.

kDSPROF_UserObjects 

User objects.

kDSPROF_ProductsFile 

PRODUCTS.TXT file data.

kDSPROF_MediaInfoFile 

SERIAL.ENC/MEDIA.TXT file data.