 |
NAVTOR SDK
v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
|
|
Go to the documentation of this file. 1 #ifndef SDK_GDB_WORKSPACE_INTERFACE_H_
11 #define SDK_GDB_WORKSPACE_INTERFACE_H_
17 #include <base/inc/interfaces/tree/tree_interface.h>
25 SDK_GDB_BEGIN_NAMESPACE
28 class IWorkspaceUpdateHistory;
71 kWorkspaceProperty_User = 0xFFFF
89 typedef SDKUInt64 WorkspaceFlags;
128 kWorkspaceConfigurationParameter_Max,
146 virtual GDBResult SDK_CALLTYPE
Open(
158 const SDKString& root_catalog_path_name,
175 const SDKString& file_name,
187 virtual GDBResult SDK_CALLTYPE
Create(
219 IEnumSDKString** names,
220 SDKString* geodatabase_wkn_location)
const throw() = 0;
226 const SDKString& new_location)
throw() = 0;
235 const SDKAny& pathname_or_prsp,
247 IWorkspaceUpdateHistory** update_history)
throw() = 0;
283 const SDKString* pathname,
302 GeoInt sw_lon, GeoInt ne_lat, GeoInt ne_lon,
303 geometry::IGeometry** filter)
const throw() = 0;
322 geometry::IGeometryEdit** geometry)
const throw() = 0;
338 const SDKAny& pathname_or_prsp,
360 SDKUInt32& count)
const throw() = 0;
368 SDKString& workspace_name)
const throw() = 0;
372 virtual GDBResult SDK_CALLTYPE
GetWorkspace(
const SDKString& name,
387 const SDKString& workspace_name)
throw() = 0;
399 const SDKString& wks_name,
401 sdk::gdb::WorkspaceID& workspace_id)
throw() = 0;
417 virtual GDBResult SDK_CALLTYPE
GetName(
418 SDKString& name)
const throw() = 0;
426 SDKString& path)
const throw() = 0;
434 SDKString& name)
const throw() = 0;
441 virtual GDBResult SDK_CALLTYPE
GetFlags(
442 WorkspaceFlags& flags)
const throw() = 0;
452 SDKAny& value)
const throw() = 0;
462 const SDKAny& value)
throw() = 0;
464 template<
typename T >
466 T& out)
const throw() {
471 if (ANY_IS_EMPTY(&value))
529 WorkspaceID&
id)
const throw() = 0;
564 SDKAny& value)
const throw() = 0;
577 ICatalog** catalog)
const throw() = 0;
605 geometry::IGeometry* geometric_filter,
623 geometry::IGeometry* geometric_filter,
635 DatasetID dataset_id,
646 const SDKString& dataset_name,
663 virtual GDBResult SDK_CALLTYPE
GetState(
669 IWorkspaceUpdateHistory** update_history)
throw() = 0;
678 IPermitCollection** permit_collection)
throw() = 0;
689 const SDKString& dataset_name,
690 DatasetID& dataset_id)
const throw() = 0;
709 geometry::IGeometry* geometry_filter,
749 const SDKString& cell_name,
752 template<
typename T >
758 if (ANY_IS_EMPTY(&value))
780 virtual GDBResult SDK_CALLTYPE StartEditing() throw() = 0;
788 virtual GDBResult SDK_CALLTYPE StopEditing(
789 bool save_edits) throw() = 0;
792 virtual
bool IsBeingEdited() const throw() = 0;
800 virtual GDBResult SDK_CALLTYPE SetRootCatalog(
811 virtual GDBResult SDK_CALLTYPE SetWorkspaceProperty(
813 const SDKAny& value) const throw() = 0;
824 virtual GDBResult SDK_CALLTYPE CreateDataset(
826 IDatasetProperties* dataset_properties,
836 virtual GDBResult SDK_CALLTYPE AddDataset(
845 virtual GDBResult SDK_CALLTYPE DeleteDataset(
846 DatasetID dataset_id) throw() = 0;
848 SDK_IMPLEMENT_IID(IWorkspaceEdit)
849 SDK_END_INTERFACE(IWorkspaceEdit)
851 SDK_DECLARE_IID(IWorkspaceEdit)
860 virtual GDBResult SDK_CALLTYPE OnStartModifying (
865 virtual GDBResult SDK_CALLTYPE OnStopModifying(
868 SDK_IMPLEMENT_IID(IWorkspaceEvents)
869 SDK_END_INTERFACE(IWorkspaceEvents)
871 SDK_DECLARE_IID(IWorkspaceEvents)
884 virtual GDBResult SDK_CALLTYPE Next(
887 virtual void Reset() throw() = 0;
889 SDK_IMPLEMENT_IID(IEnumWorkspace)
890 SDK_END_INTERFACE(IEnumWorkspace)
892 SDK_DECLARE_IID(IEnumWorkspace)
906 virtual GDBResult SDK_CALLTYPE Next(
907 DatasetID* dataset_id)
const throw() = 0;
910 virtual GDBResult SDK_CALLTYPE Reset()
const throw() = 0;
929 IDataset** dataset)
const throw() = 0;
932 virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
1015 virtual SDKResult SDK_CALLTYPE Step(SDKUInt32 current_operation,
1016 double percent_done, SDKUInt8& cancel)
throw() = 0;
1075 virtual SDKResult SDK_CALLTYPE GetTree(ISDKTreeItem** first_item)
const = 0;
1081 virtual SDKResult SDK_CALLTYPE SetState(SDKUInt32
id, SDKUInt32 state) = 0;
1088 virtual SDKResult SDK_CALLTYPE GetState(SDKUInt32
id,
1089 SDKUInt32& state, SDKUInt32& indication_id)
const = 0;
1096 SDKUInt32& state)
const = 0;
1101 virtual SDKResult SDK_CALLTYPE ToJSON(SDKString& json)
const = 0;
1106 virtual SDKResult SDK_CALLTYPE FromJSON(
const SDKString& json) = 0;
1121 geometry::IGeometry* checked_geom,
1150 virtual GDBResult SDK_CALLTYPE PerformGroundingCheck(
1151 geometry::IGeometry* geometry_filter,
1179 virtual GDBResult SDK_CALLTYPE GetFeatures(
1194 virtual GDBResult SDK_CALLTYPE GetFeaturesByIndex(SDKUInt32 index,
1195 IEnumFeature** features, geometry::IGeometry** zone_geometry)
1207 virtual GDBResult SDK_CALLTYPE SetFeatures(SDKUInt32 index,
1208 IEnumFeature* features, geometry::IGeometry* zone_geometry)
throw() = 0;
1217 virtual GDBResult SDK_CALLTYPE AppendFeatures(SDKUInt32 index,
1226 virtual GDBResult SDK_CALLTYPE RemoveFeatures(
1227 SDKUInt32 index, SDKUInt32 count)
throw() = 0;
1236 virtual GDBResult SDK_CALLTYPE GetUsedDatasets(
1245 virtual GDBResult SDK_CALLTYPE SetAlertsFilter(
1253 SDK_GDB_END_NAMESPACE
1255 #endif // SDK_GDB_WORKSPACE_INTERFACE_H_
Feature attributes filter.
Definition: gdb_dataset.h:694
Describes interfaces for editing of geo-database feature object.
virtual GDBResult SDK_CALLTYPE GetRootPath(SDKString &path) const =0
Returns the workspace root path.
virtual GDBResult SDK_CALLTYPE GetWorkspaceByID(WorkspaceID id, IWorkspace **workspace)=0
Returns the Workspace specified by workspace identifier from the workspace collection.
@ kDatasetParameter_IgnoreTerminatedFlag
Ignore terminated flag.
Definition: gdb_workspace.h:101
GroundingCheckAlertsState
Grounding check alert group states.
Definition: gdb_workspace.h:1053
ValidationOperations
Validation operations.
Definition: gdb_workspace.h:975
@ kGroundingCheckAlertGroupPriority_Unknown
Unknown alert group priority.
Definition: gdb_workspace.h:1046
Workspace states.
Definition: gdb_workspace.h:76
DatasetParameters
Dataset parameters of the dataset enumerator.
Definition: gdb_workspace.h:93
virtual GDBResult SDK_CALLTYPE GetDataset(DatasetID dataset_id, IDataset **dataset)=0
Returns a fully constructed dataset object specified by id.
@ kEncryptionParameter_S63_PermitsPath
Path to permits.
Definition: gdb_workspace.h:485
@ kDatasetParameter_ExcludeDatasetIDs
Exclude Dataset IDs. List of dataset IDs.
Definition: gdb_workspace.h:111
@ kGroundingCheckAlertGroupProperty_Priority
Alert group priority - GroundingCheckAlertGroupPriorities.
Definition: gdb_workspace.h:1031
virtual GDBResult SDK_CALLTYPE RemoveWorkspace(const SDKString &workspace_name)=0
Removes the Workspace from the workspace collection.
A Workspace is a container of spatial and non-spatial datasets. Workspace is a non-creatable object....
Definition: gdb_workspace.h:525
@ kGroundingCheckAlertsState_Unchecked
Alert group is unchecked.
Definition: gdb_workspace.h:1054
Provides access to members that create and open workspaces and supply workspace factory information.
Definition: gdb_workspace.h:134
@ kValidationOperation_ValidateFeatureDatasets
Validating of the feature datasets.
Definition: gdb_workspace.h:976
Specifies an interface for a GDB Geometry object.
Definition: gdb_feature_edit.h:29
@ kDatasetParameter_InDatasetNameOrder
Return datasets in the dataset name order.
Definition: gdb_workspace.h:109
Grounding check alerts.
Definition: gdb_workspace.h:1115
Provides access to the workspace configuration.
Definition: gdb_workspace.h:410
Provides access to members that enumerate through dataset ids.
Definition: gdb_workspace.h:898
virtual GDBResult SDK_CALLTYPE CreateRectGeometryFilter(GeoInt sw_lat, GeoInt sw_lon, GeoInt ne_lat, GeoInt ne_lon, geometry::IGeometry **filter) const =0
Creates a rectangular geometry filter.
@ kValidationParameter_ValidateAll
If this parameter is set, the validation does not stop on the first invalid object.
Definition: gdb_workspace.h:970
virtual GDBResult SDK_CALLTYPE GetWorkspaceID(WorkspaceID &id) const =0
Returns Workspace identifier.
@ kWorkspaceProperty_Flags
Flags of the workspace.
Definition: gdb_workspace.h:67
virtual GDBResult SDK_CALLTYPE OpenFromFile(const SDKString &file_name, IWorkspaceConfiguration *configuration, IWorkspace **workspace)=0
Opens the workspace specified by the given file name.
Describes interfaces that manages a geodatabase feature catalog object aka Dictionary.
@ kDatasetParameter_OverlayType
Overlay type filter.
Definition: gdb_workspace.h:105
CellActuality
Actuality status of an installed ENC cell relative to the data server product list (PRODUCTS....
Definition: gdb_workspace.h:507
GroundingCheckAlertGroupCategories
Grounding check alert group categories.
Definition: gdb_workspace.h:1037
@ kDatasetParameter_MinScale
Dataset minimum display scale.
Definition: gdb_workspace.h:95
@ kWorkspaceConfigurationParameter_Name
Workspace name.
Definition: gdb_workspace.h:118
@ kGroundingCheckAlertGroupProperty_Name
Full name of the alert group.
Definition: gdb_workspace.h:1027
@ kWorkspaceConfigurationParameter_Flags
Workspace flags.
Definition: gdb_workspace.h:119
virtual GDBResult SDK_CALLTYPE GetWorkspaceFactory(IWorkspaceFactory **factory)=0
Returns a reference back to the workspace factory for this workspace.
@ kDatasetParameter_UseDatasetCoverage
It could be a slow operation, use with care.
Definition: gdb_workspace.h:107
WorkspacePropertyId
Workspace property enumeration.
Definition: gdb_workspace.h:59
virtual GDBResult SDK_CALLTYPE GetRootCatalogName(SDKString &name) const =0
Returns the workspace root catalog name.
virtual GDBResult SDK_CALLTYPE OpenRootCatalogEx(IWorkspaceConfiguration *configuration, IRootCatalog **root_catalog)=0
Opens the geodatabase root catalog.
@ kWorkspaceConfigurationParameter_SourcePath
Source path to build chart catalog of it.
Definition: gdb_workspace.h:124
virtual GDBResult SDK_CALLTYPE GetGeodatabasesNamesFromWKNLocation(IEnumSDKString **names, SDKString *geodatabase_wkn_location) const =0
Returns names of the geodatabases located in the directory specified in the SDK configuration as a kn...
Describes interfaces for editing of geometry objects.
WorkspaceConfigurationParameterId
Definition of the workspace configuration parameter ids.
Definition: gdb_workspace.h:117
virtual GDBResult SDK_CALLTYPE OpenRootCatalog(const SDKString &root_catalog_path_name, IRootCatalog **root_catalog)=0
Opens the geodatabase root catalog.
@ kDatasetParameter_MU_ReturnUpdatedDatasets
return manually updated datasets
Definition: gdb_workspace.h:112
virtual GDBResult SDK_CALLTYPE GetConfigurationParameter(WorkspaceConfigurationParameterId parameter_id, SDKAny &value) const =0
Returns the value of the specified parameter.
Provides access to members that is used for getting various parameter containers.
Definition: gdb_workspace.h:269
@ kWorkspaceConfigurationParameter_EncryptionParameters
Encryption parameters, IEncryptionParameters expected.
Definition: gdb_workspace.h:122
@ kWorkspaceProperty_Encryption
Encryption type.
Definition: gdb_workspace.h:62
Describes interfaces that manages a geodatabase catalog.
GroundingCheckAlertsIndication
Grounding check alert group indications.
Definition: gdb_workspace.h:1061
@ kWorkspaceFlag_Encrypted
Indicates that the workspace contains some encrypted datasets.
Definition: gdb_workspace.h:85
@ kRootCatGeodatabaseProperty_SencVersion
SENC database version.
Definition: gdb_catalog.h:130
@ kWorkspaceProperty_SencDescription
SENC description.
Definition: gdb_workspace.h:69
@ kWorkspaceConfigurationParameter_TempPath
Temp path.
Definition: gdb_workspace.h:127
Provides access to members for managing a permit collection.
@ kCellActuality_NewEditionAvailable
A newer base edition is available.
Definition: gdb_workspace.h:516
virtual GDBResult SDK_CALLTYPE GetCellActuality(const SDKString &cell_name, CellActuality &actuality)=0
Returns the actuality status of an installed ENC cell relative to the data server product list (PRODU...
An util for grounding check.
Definition: gdb_workspace.h:1131
virtual GDBResult SDK_CALLTYPE GetWorkspaceByIndex(SDKUInt32 index, IWorkspace **workspace)=0
Returns the Workspace specified by index in the workspace collection.
DatasetType
The dataset type definition.
Definition: gdb_dataset.h:46
@ kGroundingCheckAlertGroupCategory_B
Alert group category B.
Definition: gdb_workspace.h:1040
static const SDKUInt32 WorkspaceStateBit_Modifying
Indicates that a workspace is in the modifying state.
Definition: gdb_workspace.h:55
virtual GDBResult SDK_CALLTYPE GetFeature(ObjectID id, IFeature **feature)=0
Returns the feature specified by the object identifier.
CatalogType
The catalog type.
Definition: gdb_catalog.h:78
@ kDatasetParameter_MaxScale
Dataset maximum display scale.
Definition: gdb_workspace.h:96
Provides access to members for reading a Catalog. A Catalog is a collection of entries that specifies...
Definition: gdb_catalog.h:295
virtual GDBResult SDK_CALLTYPE CreateGeometry(geometry::GeometryType geometry_type, geometry::IGeometryEdit **geometry) const =0
Creates an empty geometry container.
@ kWorkspaceProperty_DatasetCacheMemorySizeLimit
Memory size limit of the dataset cache.
Definition: gdb_workspace.h:70
@ kRootCatGeodatabaseProperty_SencDescription
SENC description.
Definition: gdb_catalog.h:132
Provides access to members that can be used for accessing workspaces of a workspace collection.
Definition: gdb_workspace.h:356
@ kGroundingCheckResultProperty_UsedProjection
Used projection.
Definition: gdb_workspace.h:1165
virtual GDBResult SDK_CALLTYPE Create(IWorkspaceConfiguration *config, IWorkspace **workspace)=0
Creates an empty workspace.
@ kWorkspaceFlag_Archived
Indicates that the workspace contains some archived datasets.
Definition: gdb_workspace.h:86
@ kWorkspaceProperty_CompilationTime
Geodatabase compilation time.
Definition: gdb_workspace.h:61
ValidationContinueCancel
Validation operations.
Definition: gdb_workspace.h:981
Grounding check alerts.
Definition: gdb_workspace.h:1070
@ kRootCatGeodatabaseProperty_ENCIssueDate
Last compiled ENC database issue date.
Definition: gdb_catalog.h:129
@ Ok
Operation completed successfully.
Definition: sdk_results_enum.h:22
@ kValidation_Continue
Continue the validation.
Definition: gdb_workspace.h:982
Provides access to members that supply dataset information.
Definition: gdb_dataset.h:357
virtual GDBResult SDK_CALLTYPE CreateQueryParameters(IQueryParameters **parameters) const =0
Creates an empty Object parameters.
virtual GDBResult SDK_CALLTYPE Open(IWorkspaceConfiguration *configuration, IWorkspace **workspace)=0
Opens the workspace specified by the properties.
Occurs when GetFeatures is called asynchronously.
Definition: gdb_workspace.h:950
@ kDatasetParameter_DID
DatasetID filter.
Definition: gdb_workspace.h:106
virtual GDBResult SDK_CALLTYPE GetConfiguration(IWorkspaceConfiguration **configuration) const =0
Returns the pointer to configuration object that was used during the workspace construction.
SDKUInt32 PRSP
Product specification.
Definition: gdb_const.h:250
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
@ kDatasetParameter_MU_ReturnManualUpdates
return manual updates datasets only
Definition: gdb_workspace.h:104
@ kEncryptionParameter_RootResourceStorage
Root resource storage.
Definition: gdb_workspace.h:487
@ kGroundingCheckAlertGroupCategory_A
Alert group category A.
Definition: gdb_workspace.h:1039
virtual GDBResult SDK_CALLTYPE ChangeGeodatabasesWKNLocation(const SDKString &new_location)=0
Changes the geodatabase WKN location in the SDK configuration.
virtual GDBResult SDK_CALLTYPE GetWorkspaceUpdateHistory(IWorkspaceUpdateHistory **update_history)=0
Returns the IWorkspaceUpdateHistory interface associated with the workspace update history.
@ kWorkspaceProperty_GeodatabaseName
Geodatabase Name of a workspace.
Definition: gdb_workspace.h:60
SDKUInt32 reserved
Reserved for future use.
Definition: gdb_workspace.h:79
Geo database constants and structures.
WorkspaceFlagsEnum
Workspace flags.
Definition: gdb_workspace.h:84
@ Err_InvalidArg
Wrong argument passed to function.
Definition: sdk_results_enum.h:27
virtual GDBResult SDK_CALLTYPE GetCatalog(CatalogType catalog_type, ICatalog **catalog) const =0
Returns the pointer to the workspace catalog specified by the type of the catalog.
@ kWorkspaceProperty_SencVersion
SENC database version.
Definition: gdb_workspace.h:65
@ kDatasetParameter_ProductSpecificationDescription
Product specification description filter (string).
Definition: gdb_workspace.h:108
@ kGroundingCheckAlertGroupProperty_ID
Unique integer identifier.
Definition: gdb_workspace.h:1026
@ kWorkspaceConfigurationParameter_ManualUpdateParameters
Manual update parameters, ISDKParameters expected.
Definition: gdb_workspace.h:126
@ kGroundingCheckAlertGroupPriority_Warning
Alert group priority - Warning.
Definition: gdb_workspace.h:1048
virtual GDBResult SDK_CALLTYPE GetFeatureCatalog(PRSP prsp, IClassCatalog **feature_catalog) const =0
Returns the pointer to the feature catalog specified by the PRSP.
virtual GDBResult SDK_CALLTYPE GetName(SDKString &name) const =0
Returns the workspace name.
virtual GDBResult SDK_CALLTYPE GetDatasetByName(const SDKString &dataset_name, IDataset **dataset)=0
Returns a fully constructed dataset object specified by name.
Validates the data.
Definition: gdb_workspace.h:988
@ kDatasetParameter_IgnorePermits
Suppress to check permits.
Definition: gdb_workspace.h:97
@ kRootCatGeodatabaseProperty_CompilationTime
Geodatabase compilation time.
Definition: gdb_catalog.h:126
GroundingCheckAlertGroupPriorities
Grounding check alert group priorities.
Definition: gdb_workspace.h:1045
virtual GDBResult SDK_CALLTYPE GetPermits(IPermitCollection **permit_collection)=0
Returns the IPermitCollection interface associated with the workspace permits.
@ kWorkspaceProperty_NavStick
Indicates whether a geodatabase was compiled from NAVTOR NavStick.
Definition: gdb_workspace.h:63
Provides access to members that can be used for accessing individual Classes.
Definition: gdb_feature_catalog.h:164
SDKUInt32 cb_size
Specifies the size of the structure in bytes.
Definition: gdb_workspace.h:77
virtual GDBResult SDK_CALLTYPE CreateEncryptionParameters(IEncryptionParameters **encryption_parameters) const =0
Create an empty encryption parameters container that should be used as a workspace configuration para...
Feature is a spatial object. A feature has an associated shape. A feature may have a shape with more ...
Definition: gdb_feature.h:187
Common base SDK interfaces.
GroundingCheckAlertGroupProperties
Grounding check alert group properties.
Definition: gdb_workspace.h:1025
virtual GDBResult SDK_CALLTYPE GetWorkspaceCount(SDKUInt32 &count) const =0
Returns number of workspaces in the collection.
@ kRootCatGeodatabaseProperty_NavStick
Indicates if a geodatabase was compiled from NAVTOR NavStick.
Definition: gdb_catalog.h:128
virtual GDBResult SDK_CALLTYPE GetFeatures(geometry::IGeometry *geometry_filter, IQueryParameters *parameters, IFeatureFilter *back_call_feature_filter, IEnumFeature **features)=0
Returns an enumeration of the features which contain in this workspace.
@ kGroundingCheckAlertsIndicationID_SafetyContour
Safety contour indication.
Definition: gdb_workspace.h:1065
virtual GDBResult SDK_CALLTYPE GetDatasets(geometry::IGeometry *geometric_filter, IQueryParameters *parameter_filter, IEnumDataset **datasets)=0
Returns an enumerator over the datasets in the workspace of the specified geometric and parameters fi...
#define SDK_FAILED(res)
Checks failed result.
Definition: sdk_results_enum.h:69
virtual GDBResult SDK_CALLTYPE GetFeatureAttributesFilter(IFeatureAttributesFilter **filter) const =0
Creates a feature attributes filter.
@ kGroundingCheckAlertGroupProperty_FullDescription
Optional full description of the alert group.
Definition: gdb_workspace.h:1029
@ kGroundingCheckAlertGroupPriority_Alarm
Alert group priority - Alarm.
Definition: gdb_workspace.h:1047
Object identifier.
Definition: gdb_const.h:115
SDKUInt32 state_bits
Indicates current state bits of the workspace.
Definition: gdb_workspace.h:78
@ kEncryptionParameter_DatasetCatalog
Dataset catalog. For internal use.
Definition: gdb_workspace.h:486
virtual GDBResult SDK_CALLTYPE OpenFeatureCatalog(const SDKAny &pathname_or_prsp, IClassCatalog **class_catalog)=0
Opens a feature catalog specified by pathname.
virtual GDBResult SDK_CALLTYPE GetWorkspaceProperty(WorkspacePropertyId property_id, SDKAny &value) const =0
Returns properties of the workspace.
@ kDatasetParameter_DatasetNameContext
Can be used for context search.
Definition: gdb_workspace.h:98
@ kWorkspaceConfigurationParameter_ManualUpdateRootPath
Manual update root path.
Definition: gdb_workspace.h:123
@ kDatasetParameter_PRSP
Dataset PRSP or list of PRSPs.
Definition: gdb_workspace.h:94
virtual GDBResult SDK_CALLTYPE CreateWorkspaceConfiguration(IWorkspaceConfiguration **config)=0
Creates an empty workspace configuration.
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
@ kWorkspaceConfigurationParameter_RootCatalogName
Workspace root catalog name.
Definition: gdb_workspace.h:121
@ kCellActuality_UpToDate
Definition: gdb_workspace.h:511
virtual GDBResult SDK_CALLTYPE AddWorkspace(const SDKString &wks_name, IWorkspace *wks, sdk::gdb::WorkspaceID &workspace_id)=0
Adds a Workspace into the workspace collection.
This class wraps the SDKAny type.
Definition: sdk_any_handler.h:32
@ Err_NotExist
Not exist.
Definition: sdk_results_enum.h:26
@ kRootCatGeodatabaseProperty_Encryption
Encryption type used for the datasets encryption. See sdk::gdb::senc::ENCA_Enum.
Definition: gdb_catalog.h:127
@ kDatasetParameter_WX_TimeFilter
specifies the WX time filter
Definition: gdb_workspace.h:103
@ kDatasetParameter_ExcludePRSP
Exclude Dataset PRSP or list of PRSPs.
Definition: gdb_workspace.h:100
GeometryType
Available types of geometry objects.
Definition: geometry.h:73
virtual GDBResult SDK_CALLTYPE GetWorkspaceName(SDKUInt32 index, SDKString &workspace_name) const =0
Returns the workspace name specified by index in collection.
@ kDatasetParameter_DatasetNameContextFirstOccurrence
Returns only first occurrence.
Definition: gdb_workspace.h:99
@ kDatasetParameter_WX_ProductFilter
specifies the WX product filter
Definition: gdb_workspace.h:102
@ kRootCatGeodatabaseProperty_ValidThrough
SENC valid through date.
Definition: gdb_catalog.h:131
Provides access to members that enumerate through datasets.
Definition: gdb_workspace.h:920
virtual GDBResult SDK_CALLTYPE OpenDataProducerCodesCatalog(const SDKString *pathname, ICatalog **catalog)=0
Opens the data producer codes catalog. See DataProducerCodesCatalogEntryProperty for details.
@ kRootCatGeodatabaseProperty_GeodatabaseName
Geodatabase name.
Definition: gdb_catalog.h:125
@ kGroundingCheckAlertGroupProperty_IndicationID
Alert group indication id - GroundingCheckAlertsIndication.
Definition: gdb_workspace.h:1032
@ kCellActuality_UpdateAvailable
Definition: gdb_workspace.h:514
Provides access to members that managing the root catalog.
Definition: gdb_catalog.h:415
virtual GDBResult SDK_CALLTYPE GetDatasetIDs(geometry::IGeometry *geometric_filter, IQueryParameters *parameter_filter, IEnumDatasetID **enum_dataset_id)=0
Returns an enumerator over the dataset identifiers in the workspace for the specified geometric and p...
Feature filter.
Definition: gdb_dataset.h:671
virtual GDBResult SDK_CALLTYPE CreateAttributeCollection(IAttributeCollectionEdit **attribute_collection) const =0
Creates an empty attribute collection.
Grounding check result.
Definition: gdb_workspace.h:1170
virtual GDBResult SDK_CALLTYPE GetWorkspaces(IWorkspaceCollection **workspaces)=0
The GetWorkspaces method returns the pointer to the IWorkspaceCollection interface associated with th...
virtual GDBResult SDK_CALLTYPE SetConfigurationParameter(WorkspaceConfigurationParameterId parameter_id, const SDKAny &value)=0
Sets the value of the specified parameter.
@ kGroundingCheckAlertsIndicationID_AreasWithSpecialConditions
Areas for which Special Conditions exist indication.
Definition: gdb_workspace.h:1064
@ kGroundingCheckAlertsState_Checked
Alert group is checked. All subgroups are checked.
Definition: gdb_workspace.h:1056
@ kGroundingCheckAlertGroupProperty_Category
Alert group category - GroundingCheckAlertGroupCategories.
Definition: gdb_workspace.h:1030
@ kWorkspaceConfigurationParameter_RootResourceStorage
Root resource storage.
Definition: gdb_workspace.h:125
@ kCellActuality_Withdrawn
Definition: gdb_workspace.h:517
@ kGroundingCheckAlertGroupProperty_ShortDescription
Short description of the alert group.
Definition: gdb_workspace.h:1028
@ kWorkspaceConfigurationParameter_RootPath
Workspace root path.
Definition: gdb_workspace.h:120
Validation progress event.
Definition: gdb_workspace.h:1007
@ kCellActuality_Unknown
Definition: gdb_workspace.h:508
Describes a basic enumeration interfaces.
@ kGroundingCheckAlertsIndicationID_NavigationalHazards
Navigational hazards indication.
Definition: gdb_workspace.h:1063
EncryptionParameters
Encryption parameters.
Definition: gdb_workspace.h:483
Enumerates the features.
Definition: gdb_dataset.h:614
virtual GDBResult SDK_CALLTYPE GetState(WorkspaceState &state) const =0
Retrieves the status for a workspace.
Provides access to members for managing an Object parameter set.
Definition: gdb_workspace.h:941
@ kEncryptionParameter_S63_HWID
HWID for permits decryption.
Definition: gdb_workspace.h:484
Parameters for initialization of the dataset encryption.
Definition: gdb_workspace.h:492
@ kValidationParameter_SelectiveValidation
Definition: gdb_workspace.h:967
virtual GDBResult SDK_CALLTYPE GetFlags(WorkspaceFlags &flags) const =0
Returns the workspace flags.
@ kGroundingCheckAlertsState_PartiallyChecked
Alert group is partly checked. Some subgroups are checked.
Definition: gdb_workspace.h:1055
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
virtual GDBResult SDK_CALLTYPE GetWorkspace(const SDKString &name, IWorkspace **workspace)=0
Returns the Workspace specified by workspace name from the workspace collection.
virtual GDBResult SDK_CALLTYPE GetGroundingCheckAlerts(const SDKAny &pathname_or_prsp, IGroundingCheckAlerts **alert_filter) const =0
Creates and loads grounding check alert filter.
@ kWorkspaceProperty_ValidThrough
SENC valid through.
Definition: gdb_workspace.h:68
ValidationParameters
Validation parameters.
Definition: gdb_workspace.h:966
kGroundingCheckResultProperties
Grounding check result properties.
Definition: gdb_workspace.h:1164
@ kWorkspaceProperty_Name
Name of a workspace.
Definition: gdb_workspace.h:66
@ kDatasetParameter_IncludeDatasetIDs
Include Dataset IDs. List of dataset IDs.
Definition: gdb_workspace.h:110
@ kGroundingCheckAlertsIndicationID_NoIndication
Indication does not exist.
Definition: gdb_workspace.h:1062
@ kGroundingCheckAlertGroupCategory_Unknown
Unknown alert group category.
Definition: gdb_workspace.h:1038
virtual GDBResult SDK_CALLTYPE OpenUpdateHistory(IRootCatalog *root_catalog, IWorkspaceUpdateHistory **update_history)=0
Returns the IWorkspaceUpdateHistory interface associated with the workspace update history.
@ kWorkspaceProperty_ENCIssueDate
Last compiled ENC database issue date.
Definition: gdb_workspace.h:64
virtual GDBResult SDK_CALLTYPE GetDatasetID(const SDKString &dataset_name, DatasetID &dataset_id) const =0
Returns the dataset id for the dataset specified by name.
Wrappers for work with SDKAny instance.
@ kValidation_Cancel
Cancel the validation.
Definition: gdb_workspace.h:983