NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
gdb_update_history.h
Go to the documentation of this file.
1 
9 #ifndef SDK_GDB_UPDATE_HISTORY_INTERFACE_H_
10 #define SDK_GDB_UPDATE_HISTORY_INTERFACE_H_
11 #pragma once
12 
14 #include <base/inc/sdk_ref_ptr.h> // Smart pointer implementation.
17 
18 namespace sdk {
19 namespace gdb { // geodatabase
20 // Classes declared in other files
21 class IQueryParameters;
22 // Classes declared in this file
23 FWD_DECL_INTERFACE(IWorkspaceUpdateHistory);
24 
27 typedef enum UPHQueryParameterEnum {
37 
40 typedef enum UpdateHistoryColumns {
41  kUPH_DSNM = 1,
54 
66 
69 typedef enum UpdateHistoryCDColumns {
75 
79 public:
82  virtual GDBResult SDK_CALLTYPE GetWorkspaceUpdateHistory(
83  IQueryParameters* parameters, sql::IRowSet** row_set) throw() = 0;
84 
86  virtual GDBResult SDK_CALLTYPE GetDatasetUpdateHistory(
87  const char* dataset_name, sql::IRowSet** row_set) throw() = 0;
88 
91  virtual GDBResult SDK_CALLTYPE GetDatasetUpdateRecords(
92  const char* dataset_name, const SDKUInt64& updn,
93  sql::IRowSet** row_set) throw() = 0;
94 
96  virtual GDBResult SDK_CALLTYPE GetUpdateCDRecords(
97  const SDKTime& cd_issue_date, sql::IRowSet** row_set) throw() = 0;
98 
99  SDK_IMPLEMENT_IID(IWorkspaceUpdateHistory)
100  SDK_END_INTERFACE(IWorkspaceUpdateHistory)
101 };
102 SDK_DECLARE_IID(IWorkspaceUpdateHistory)
103 
104 } // namespace gdb
105 } // namespace sdk
106 
107 #endif // SDK_GDB_UPDATE_HISTORY_INTERFACE_H_
sdk::gdb::IWorkspaceUpdateHistory::GetUpdateCDRecords
virtual GDBResult SDK_CALLTYPE GetUpdateCDRecords(const SDKTime &cd_issue_date, sql::IRowSet **row_set)=0
Returns the update CD records for the designated CD issue date.
sdk::gdb::UpdateHistoryRecordColumns
UpdateHistoryRecordColumns
List of the update records table columns.
Definition: gdb_update_history.h:57
sdk::gdb::kUPH_REJECTED
@ kUPH_REJECTED
Rejected sign.
Definition: gdb_update_history.h:49
sdk::gdb::kUPH_CD_CDISDT
@ kUPH_CD_CDISDT
CD issue date.
Definition: gdb_update_history.h:70
sdk::gdb::kUPH_REC_RUIN
@ kUPH_REC_RUIN
Record update instruction.
Definition: gdb_update_history.h:63
sdk::gdb::kUPH_CD_YEAR
@ kUPH_CD_YEAR
CD issue year.
Definition: gdb_update_history.h:73
sdk::gdb::kUPH_ISDT
@ kUPH_ISDT
Issue date.
Definition: gdb_update_history.h:44
sdk::gdb::IWorkspaceUpdateHistory::GetWorkspaceUpdateHistory
virtual GDBResult SDK_CALLTYPE GetWorkspaceUpdateHistory(IQueryParameters *parameters, sql::IRowSet **row_set)=0
By default returns the list of updated datasets. The query can be customized by the parameters,...
sdk::gdb::kUPH_EDTN
@ kUPH_EDTN
Edition number.
Definition: gdb_update_history.h:51
sdk_ref_ptr.h
Interfaces wrapper with reference count control.
sdk::gdb::IWorkspaceUpdateHistory
Provides access to members that manage the workspace update history.
Definition: gdb_update_history.h:78
sdk::sql::IRowSet
Provides method for fetching rows sequentially, getting data from those rows and managing rows.
Definition: sql_interface.h:45
sdk::gdb::kUPH_REC_DSNM
@ kUPH_REC_DSNM
Dataset name.
Definition: gdb_update_history.h:58
sql_interface.h
Describes interfaces that manage sql database.
sdk::gdb::kUPH_QUERY_SELECT_COUNT
@ kUPH_QUERY_SELECT_COUNT
Free SQL select count.
Definition: gdb_update_history.h:35
sdk::gdb::IWorkspaceUpdateHistory::GetDatasetUpdateHistory
virtual GDBResult SDK_CALLTYPE GetDatasetUpdateHistory(const char *dataset_name, sql::IRowSet **row_set)=0
Returns the dataset update history for the designated dataset.
sdk::gdb::UPHQueryParameterEnum
UPHQueryParameterEnum
Parameters for the update history query.
Definition: gdb_update_history.h:27
sdk::gdb::kUPH_QUERY_SELECT
@ kUPH_QUERY_SELECT
Free SQL select.
Definition: gdb_update_history.h:34
sdk::gdb::kUPH_NEWED
@ kUPH_NEWED
New edition sign.
Definition: gdb_update_history.h:47
sdk::gdb::kUPH_CANCEL
@ kUPH_CANCEL
Cancel update.
Definition: gdb_update_history.h:48
sdk::gdb::kUPH_QUERY_AGEN_LIST
@ kUPH_QUERY_AGEN_LIST
Comma separeated list of producing agencies.
Definition: gdb_update_history.h:32
sdk::gdb::UpdateHistoryCDColumns
UpdateHistoryCDColumns
List of the update CD table columns.
Definition: gdb_update_history.h:69
sdk::gdb::UpdateHistoryColumns
UpdateHistoryColumns
List of the update log table columns.
Definition: gdb_update_history.h:40
sdk::gdb::kUPH_UPDN
@ kUPH_UPDN
Update number.
Definition: gdb_update_history.h:43
sdk::gdb::kUPH_COMT
@ kUPH_COMT
Comment.
Definition: gdb_update_history.h:46
sdk::gdb::kUPH_REC_RCID
@ kUPH_REC_RCID
Record id.
Definition: gdb_update_history.h:60
gdb_const.h
Geo database constants and structures.
sdk::gdb::kUPH_ERRORS
@ kUPH_ERRORS
Errors.
Definition: gdb_update_history.h:50
sdk::gdb::kUPH_CODT
@ kUPH_CODT
Compilation date.
Definition: gdb_update_history.h:45
sdk::gdb::IWorkspaceUpdateHistory::GetDatasetUpdateRecords
virtual GDBResult SDK_CALLTYPE GetDatasetUpdateRecords(const char *dataset_name, const SDKUInt64 &updn, sql::IRowSet **row_set)=0
Returns the dataset update records for the designated dataset and update number.
sdk_component_interface.h
Common base SDK interfaces.
sdk::gdb::kUPH_DSNM
@ kUPH_DSNM
Dataset name.
Definition: gdb_update_history.h:41
sdk::gdb::kUPH_QUERY_TO_ISDT
@ kUPH_QUERY_TO_ISDT
To issue date. SDKTime expected.
Definition: gdb_update_history.h:29
sdk::gdb::kUPH_CD_WEEK
@ kUPH_CD_WEEK
CD issue week.
Definition: gdb_update_history.h:72
sdk::gdb::kUPH_CD_BASECD
@ kUPH_CD_BASECD
Base CD flag.
Definition: gdb_update_history.h:71
sdk::gdb::kUPH_QUERY_AGEN_ONLY
@ kUPH_QUERY_AGEN_ONLY
Return the list agencies.
Definition: gdb_update_history.h:33
sdk::gdb::kUPH_REC_OBJL
@ kUPH_REC_OBJL
Feature object label (class code).
Definition: gdb_update_history.h:64
sdk::gdb::kUPH_REC_RIND
@ kUPH_REC_RIND
SENC feature object reference.
Definition: gdb_update_history.h:62
sdk::gdb::kUPH_CDISDT
@ kUPH_CDISDT
CD issue date.
Definition: gdb_update_history.h:52
SDKTime
SDK_END_NAMESPACE typedef SDKInt64 SDKTime
Milliseconds from Unix epoch.
Definition: base_types.h:56
sdk::gdb::kUPH_QUERY_TO_CODT
@ kUPH_QUERY_TO_CODT
To compilation date. SDKTime expected.
Definition: gdb_update_history.h:31
sdk::gdb::kUPH_AGEN
@ kUPH_AGEN
Producing agency.
Definition: gdb_update_history.h:42
sdk::sql::IConnection
Interface associated with the SQL database connection object.
Definition: sql_interface.h:28
sdk::gdb::kUPH_REC_UPDN
@ kUPH_REC_UPDN
Update number.
Definition: gdb_update_history.h:59
IQueryParameters
Provides access to members for managing an Object parameter set.
Definition: gdb_workspace.h:941
sdk::gdb::kUPH_REC_RVER
@ kUPH_REC_RVER
Record version.
Definition: gdb_update_history.h:61
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
sdk::gdb::kUPH_QUERY_FROM_ISDT
@ kUPH_QUERY_FROM_ISDT
From issue date. SDKTime expected.
Definition: gdb_update_history.h:28
sdk::gdb::kUPH_QUERY_FROM_CODT
@ kUPH_QUERY_FROM_CODT
From compilation date. SDKTime expected.
Definition: gdb_update_history.h:30