data_sources_manager_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_GL_DATA_SOURCES_MANAGER_INTERFACE_H_
#define SDK_VISMAN_GL_DATA_SOURCES_MANAGER_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <datalayer/inc/geodatabase/gdb_workspace.h>
#include <datalayer/inc/geodatabase/gdb_dataset.h>
#include <visualizationlayer/inc/vis_const.h>
#include <visualizationlayer/inc/visman/scene_manager_base_interface.h>
 
SDK_VISGL_BEGIN_NAMESPACE
 
// defined here
FWD_DECL_INTERFACE(IDataSourcesManager);
FWD_DECL_INTERFACE(IDataSourceEnumerator);
FWD_DECL_INTERFACE(IDataSourceBase);
FWD_DECL_INTERFACE(IDataSource);
FWD_DECL_INTERFACE(IDataSourceRadar);
FWD_DECL_INTERFACE(IDataSourceRadarBitmap);
FWD_DECL_INTERFACE(IDataSourceGroundingCheck);
 
enum DataSourceParameters
{
  kDataSourceParameter_First = 1,
  kDataSourceParameter_Flags = 1, 
  kDataSourceParameter_Max,
};
 
enum DataSourceFlags
{
  kDataSourceFlag_None                 = sdk::vis::kDataSourceBaseFlag_None,
  kDataSourceFlag_ChartDatabase        = sdk::vis::kDataSourceBaseFlag_ChartDatabase,   
  kDataSourceFlag_WeatherDatabase      = sdk::vis::kDataSourceBaseFlag_WeatherDatabase, 
  kDataSourceFlag_RoutesDatabase       = sdk::vis::kDataSourceBaseFlag_RoutesDatabase,  
  kDataSourceFlag_ViewportData         = 0x00100000, 
  kDataSourceFlag_NoProgressiveDisplay = 0x00200000, 
};
 
static const SDKUInt64 kDataSourceFlag_UserMask = 0xFFFFFFFF00000000; 
 
static const wchar_t* kDataSourcePredefinedName_Radar       = L"radar";        
static const wchar_t* kDataSourcePredefinedName_RadarBitmap = L"radar_bitmap"; 
 
class IDataSourcesManager : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE AddDataSource(
    const SDKString&            data_source_name,
    const SDKAny&               data_source_ref,
    const ISDKParametersSP&     parameters,
    IDataSourceBaseSP&          data_source) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveDataSource(
    const SDKString& data_source_name) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE EnumDataSources(
    IDataSourceEnumeratorSP& data_source_enum) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FindDataSource(
    const SDKString&   data_source_name,
    IDataSourceBaseSP& data_source) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FindDataSourceName(
    const SDKAny& data_source_ref,
    SDKString&    data_source_name) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  SDK_IMPLEMENT_IID(IDataSourcesManager)
  SDK_END_INTERFACE(IDataSourcesManager)
};
SDK_DECLARE_IID(IDataSourcesManager)
 
class IDataSourceEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(IDataSourceBaseSP& data_source) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IDataSourceEnumerator)
  SDK_END_INTERFACE(IDataSourceEnumerator)
};
SDK_DECLARE_IID(IDataSourceEnumerator)
 
enum DataSourceProperties
{
  kDataSourceProperty_First          = 1,
  kDataSourceProperty_Priority       = 1, 
  kDataSourceProperty_UniqueNumber   = 2, 
  kDataSourceProperty_Flags          = 3, 
  kDataSourceProperty_OriginalSource = 4, 
  kDataSourceProperty_Max,
};
 
class IDataSourceBase : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetParameters(ISDKParametersSP& parameters) const throw() = 0;
 
  // ISDKProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, const SDKAny& value) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, SDKAny& value) const throw() = 0;
};
 
class IDataSource : public IDataSourceBase
{
public:
  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetParameters(ISDKParametersSP& parameters) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetFilters(
    const sdk::gdb::IQueryParametersSP& dataset_filter,
    const sdk::gdb::IQueryParametersSP& feature_query_filter,
    const sdk::gdb::IFeatureFilterSP&   feature_filter) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetFilters(
    sdk::gdb::IQueryParametersSP& dataset_filter,
    sdk::gdb::IQueryParametersSP& feature_query_filter,
    sdk::gdb::IFeatureFilterSP&   feature_filter) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IDataSource)
  SDK_END_INTERFACE(IDataSource)
};
SDK_DECLARE_IID(IDataSource)
 
enum RadarDataSourceProperties
{
  kRadarDataSourceProperty_TotalRaysCount = kDataSourceProperty_Max, 
  kRadarDataSourceProperty_PixelsPerRay,                             
  kRadarDataSourceProperty_RangeNM,                                  
  kRadarDataSourceProperty_RangeInPixels,                            
  kRadarDataSourceProperty_BitmapWidth,                              
  kRadarDataSourceProperty_BitmapHeight,                             
};
 
enum RadarImageProperties
{
  kRadarImageProperty_RadarHighlightRays, 
  kRadarImageProperty_RadarSymbolName,    
  kRadarImageProperty_RadarColorName,     
  kRadarImageProperty_RadarColorOpacity,  
  kRadarImageProperty_RadarTrailMode,     
  kRadarImageProperty_RadarTrailDecay,    
  kRadarImageProperty_RadarTrailTime,     
  kRadarImageProperty_RadarAntennaRotationPeriod, 
  kRadarImageProperty_RadarStabilizationMode, 
};
 
enum RadarStabilizationMode
{
  kRadarStabilizationMode_Ground = 0, 
  kRadarStabilizationMode_Sea    = 1, 
};
 
class IDataSourceRadar : public IDataSourceBase
{
public:
  virtual SDKResult SetRadarImageParameters(
    SDKUInt32               total_rays_count,
    SDKUInt32               pixels_per_ray,
    double                  range_nm,
    const ISDKParametersSP& other_parameters) noexcept = 0;
 
  virtual SDKResult UpdateRadarImageData(
    double          center_lon,
    double          center_lat,
    double          angle_deg,
    SDKUInt32       first_ray_index,
    SDKUInt32       rays_count,
    const SDKUInt8* rays_data,
    SDKUInt32       ray_data_size) noexcept = 0;
 
  virtual SDKResult SetRadarOwnShipNav(
    double cog_deg,
    double sog_kn,
    double hdg_deg,
    double stw_kn) noexcept = 0;
 
  virtual SDKResult SDK_CALLTYPE SetRadarImageProperty(
    const SDKPropertyID& id,
    const SDKAny&        value) noexcept = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRadarImageProperty(
    const SDKPropertyID& id,
    SDKAny&              value) const noexcept = 0;
 
  SDK_IMPLEMENT_IID(IDataSourceRadar)
  SDK_END_INTERFACE(IDataSourceRadar)
};
SDK_DECLARE_IID(IDataSourceRadar)
 
class IDataSourceRadarBitmap : public IDataSourceBase
{
public:
  virtual SDKResult SetRadarImageParameters(
    double                  range_nm,
    SDKUInt32               range_pixels,
    SDKUInt32               bitmap_width,
    SDKUInt32               bitmap_height,
    const ISDKParametersSP& other_parameters) noexcept = 0;
 
  virtual SDKResult UpdateRadarImageData(
    double                    center_lon,
    double                    center_lat,
    double                    angle_deg,
    const base::ISDKStreamSP& bitmap_data) noexcept = 0;
 
  virtual SDKResult UpdateRadarImageData(
    double          center_lon,
    double          center_lat,
    double          angle_deg,
    const SDKUInt8* bitmap_data,
    SDKUInt32       bitmap_data_size) noexcept = 0;
 
  virtual SDKResult SetRadarOwnShipNav(
    double cog_deg,
    double sog_kn,
    double hdg_deg,
    double stw_kn) noexcept = 0;
 
  virtual SDKResult SDK_CALLTYPE SetRadarImageProperty(
    const SDKPropertyID& id,
    const SDKAny&        value) noexcept = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRadarImageProperty(
    const SDKPropertyID& id,
    SDKAny&              value) const noexcept = 0;
 
  SDK_IMPLEMENT_IID(IDataSourceRadarBitmap)
  SDK_END_INTERFACE(IDataSourceRadarBitmap)
};
SDK_DECLARE_IID(IDataSourceRadarBitmap)
 
enum GroundingCheckDataSourceProperties
{
  kGroundingCheckDataSourceProperty_DrawZone,         
  kGroundingCheckDataSourceProperty_ZonesToDrawIndex, 
};
 
enum GroundingCheckResultSetType
{
  kGroundingCheckResultSetType_Direct, 
  kGroundingCheckResultSetType_Clone,  
};
 
class IDataSourceGroundingCheck : public IDataSourceBase
{
public:
  // \brief Set the grounding check result
  virtual SDKResult SetGroundingCheckResult(
    const sdk::gdb::IGroundingCheckResultSP& gc_result,
    GroundingCheckResultSetType              type,
    const ISDKParametersSP&                  parameters) noexcept = 0;
 
  SDK_IMPLEMENT_IID(IDataSourceGroundingCheck);
  SDK_END_INTERFACE(IDataSourceGroundingCheck);
};
SDK_DECLARE_IID(IDataSourceGroundingCheck);
 
SDK_VISGL_END_NAMESPACE
 
#endif // SDK_VISMAN_GL_DATA_SOURCES_MANAGER_INTERFACE_H_