NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
data_source_view_interface.h
Go to the documentation of this file.
1 
9 #ifndef SDK_VISMAN_DATA_SOURCE_VIEW_INTERFACE_H_
10 #define SDK_VISMAN_DATA_SOURCE_VIEW_INTERFACE_H_
11 
12 #include <base/inc/base_types.h>
17 
19 
23 
24 namespace sdk {
25 namespace vis {
26 
27 // defined here
28 FWD_DECL_INTERFACE(IDataSourceView);
29 FWD_DECL_INTERFACE(IDataSourceViewEnumerator);
30 
33 typedef SDKUInt32 DataSourceViewID;
34 const DataSourceViewID kDataSourceViewID_Unknown = -1;
35 
39 {
43 };
44 
48 {
49 public:
51  virtual SDKResult SDK_CALLTYPE GetID(DataSourceViewID& id) const throw() = 0;
53  virtual SDKResult SDK_CALLTYPE GetTypeName(SDKString& type_name) const throw() = 0;
55  virtual SDKResult SDK_CALLTYPE GetFlags(SDKUInt64& flags) const throw() = 0;
56 
58  virtual SDKResult SDK_CALLTYPE SetDatasetFilter(
59  const sdk::gdb::IQueryParametersSP& dataset_filter) throw() = 0;
61  virtual SDKResult SDK_CALLTYPE GetDatasetFilter(
62  sdk::gdb::IQueryParametersSP& dataset_filter) const throw() = 0;
63 
65  virtual SDKResult SDK_CALLTYPE SetFeatureQueryFilter(
66  const sdk::gdb::IQueryParametersSP& feature_query_filter) throw() = 0;
68  virtual SDKResult SDK_CALLTYPE GetFeatureQueryFilter(
69  sdk::gdb::IQueryParametersSP& feature_query_filter) const throw() = 0;
70 
72  virtual SDKResult SDK_CALLTYPE SetFeatureCallbackFilter(
73  const sdk::gdb::IFeatureFilterSP& feature_filter) throw() = 0;
75  virtual SDKResult SDK_CALLTYPE GetFeatureCallbackFilter(
76  sdk::gdb::IFeatureFilterSP& feature_filter) const throw() = 0;
77 
78  // ISDKProperties
79  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, const SDKAny& value) throw() = 0;
80  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, SDKAny& value) const throw() = 0;
81 
82  SDK_IMPLEMENT_IID(IDataSourceView)
83  SDK_END_INTERFACE(IDataSourceView)
84 };
85 SDK_DECLARE_IID(IDataSourceView)
86 
90 {
91 public:
93  virtual SDKResult SDK_CALLTYPE Next(IDataSourceViewSP& data_source_view) const throw() = 0;
95  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
96 
97  SDK_IMPLEMENT_IID(IDataSourceViewEnumerator)
98  SDK_END_INTERFACE(IDataSourceViewEnumerator)
99 };
100 SDK_DECLARE_IID(IDataSourceViewEnumerator)
101 
102 
103 } // namespace vis
104 } // namespace sdk
105 
106 #endif // SDK_VISMAN_DATA_SOURCE_VIEW_INTERFACE_H_
gdb_dataset.h
Describes interfaces that manages a geodatabase dataset object.
sdk::vis::IDataSourceViewEnumerator
Enumerates data sources.
Definition: data_source_view_interface.h:89
sdk::vis::IDataSourceView::GetFeatureQueryFilter
virtual SDKResult SDK_CALLTYPE GetFeatureQueryFilter(sdk::gdb::IQueryParametersSP &feature_query_filter) const =0
Retrieves query filter.
base_types.h
SDK base types.
sdk::vis::IDataSourceViewEnumerator::Next
virtual SDKResult SDK_CALLTYPE Next(IDataSourceViewSP &data_source_view) const =0
Returns next data-source.
sdk::vis::IDataSourceViewEnumerator::Reset
virtual SDKResult SDK_CALLTYPE Reset()=0
Resets enumeration.
gdb_workspace.h
Describes interfaces that manages a geodatabase workspace.
properties_interface.h
Object generic properties interface.
sdk::vis::IDataSourceView::GetID
virtual SDKResult SDK_CALLTYPE GetID(DataSourceViewID &id) const =0
Returns data source view identifier.
sdk::vis::IDataSourceView::SetFeatureCallbackFilter
virtual SDKResult SDK_CALLTYPE SetFeatureCallbackFilter(const sdk::gdb::IFeatureFilterSP &feature_filter)=0
Sets callback filter for feature request.
parameters_interface.h
Provides access to members for managing a parameter set.
sdk::vis::IDataSourceView::SetDatasetFilter
virtual SDKResult SDK_CALLTYPE SetDatasetFilter(const sdk::gdb::IQueryParametersSP &dataset_filter)=0
Sets dataset filter.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
gdb_const.h
Geo database constants and structures.
sdk::ISDKProperties
Provides access to members that control the properties.
Definition: properties_interface.h:32
sdk::vis::IDataSourceView
Provides access to the members that manage the data source view.
Definition: data_source_view_interface.h:47
sdk::vis::IDataSourceView::GetDatasetFilter
virtual SDKResult SDK_CALLTYPE GetDatasetFilter(sdk::gdb::IQueryParametersSP &dataset_filter) const =0
Retrieves dataset filter.
sdk::vis::DataSourceViewID
SDKUInt32 DataSourceViewID
Auto-generated Data source view identifier.
Definition: data_source_view_interface.h:33
sdk::vis::IDataSourceView::GetFlags
virtual SDKResult SDK_CALLTYPE GetFlags(SDKUInt64 &flags) const =0
Returns data source view flags (See enum AddDataSourceFlags in scene_manager_interface....
sdk_component_interface.h
Common base SDK interfaces.
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
sdk::vis::kDataSourceViewPropertyID_SourceName
@ kDataSourceViewPropertyID_SourceName
Return data source name.
Definition: data_source_view_interface.h:40
geometry_base_types.h
Geometry base types.
sdk::vis::kDataSourceViewPropertyID_OriginalSource
@ kDataSourceViewPropertyID_OriginalSource
Reference to the source provided by user.
Definition: data_source_view_interface.h:41
sdk::vis::DataSourceViewPropertyIDs
DataSourceViewPropertyIDs
Data source view properties.
Definition: data_source_view_interface.h:38
sdk::vis::IDataSourceView::GetTypeName
virtual SDKResult SDK_CALLTYPE GetTypeName(SDKString &type_name) const =0
Returns data source view type-name.
sdk::vis::IDataSourceView::GetFeatureCallbackFilter
virtual SDKResult SDK_CALLTYPE GetFeatureCallbackFilter(sdk::gdb::IFeatureFilterSP &feature_filter) const =0
Retrieves callback filter.
enum_interface.h
Describes a basic enumeration interfaces.
sdk::vis::IDataSourceView::SetFeatureQueryFilter
virtual SDKResult SDK_CALLTYPE SetFeatureQueryFilter(const sdk::gdb::IQueryParametersSP &feature_query_filter)=0
Sets query filter for feature request.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
sdk::vis::kDataSourceViewPropertyID_Priority
@ kDataSourceViewPropertyID_Priority
DataSource priority (bigger value means more important)
Definition: data_source_view_interface.h:42