data_sources_manager_interface.h File Reference

Describes visualization data sources manager. More...

#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>

Go to the source code of this file.

Data Structures
class	IDataSourcesManager
	Interface for scene manager data sources control. More...
class	IDataSourceEnumerator
	Enumerates data sources. More...
class	IDataSourceBase
	Base interface for all data sources. More...
class	IDataSource
	Provides access to the members that manage the data source. More...
class	IDataSourceRadar
	Interface to the radar data specified by rays. More...
class	IDataSourceRadarBitmap
	Interface to the radar data specified by bitmap. More...
class	IDataSourceGroundingCheck
	Allows to update grounding check data. More...

Enumerations
enum	DataSourceParameters { , kDataSourceParameter_Flags = 1 }
	Data source additional parameters. More...
enum	DataSourceFlags { ,   kDataSourceFlag_ChartDatabase = sdk::vis::kDataSourceBaseFlag_ChartDatabase, kDataSourceFlag_WeatherDatabase = sdk::vis::kDataSourceBaseFlag_WeatherDatabase, kDataSourceFlag_RoutesDatabase = sdk::vis::kDataSourceBaseFlag_RoutesDatabase, kDataSourceFlag_ViewportData = 0x00100000,   kDataSourceFlag_NoProgressiveDisplay = 0x00200000 }
	Data source flags. More...
enum	DataSourceProperties { , kDataSourceProperty_Priority = 1, kDataSourceProperty_UniqueNumber = 2, kDataSourceProperty_Flags = 3, kDataSourceProperty_OriginalSource = 4 }
	Data source properties. More...
enum	RadarDataSourceProperties {   kRadarDataSourceProperty_TotalRaysCount = kDataSourceProperty_Max, kRadarDataSourceProperty_PixelsPerRay, kRadarDataSourceProperty_RangeNM, kRadarDataSourceProperty_RangeInPixels,   kRadarDataSourceProperty_BitmapWidth, kRadarDataSourceProperty_BitmapHeight }
	Radar data source properties (set via SetRadarImageParameters method, retrieved via ISDKProperty). More...
enum	RadarImageProperties {   kRadarImageProperty_RadarHighlightRays, kRadarImageProperty_RadarSymbolName, kRadarImageProperty_RadarColorName, kRadarImageProperty_RadarColorOpacity,   kRadarImageProperty_RadarTrailMode, kRadarImageProperty_RadarTrailDecay, kRadarImageProperty_RadarTrailTime, kRadarImageProperty_RadarAntennaRotationPeriod,   kRadarImageProperty_RadarStabilizationMode }
	Radar image properties (set via SetRadarImageProperty method, retrieved via GetRadarImageProperty). More...
enum	RadarStabilizationMode { kRadarStabilizationMode_Ground = 0, kRadarStabilizationMode_Sea = 1 }
	Radar echo trails stabilization mode (IEC 62388 §11.2.2.2 h). Ground-stab true trails keep the trail frame fixed to the ground (the trail origin O0 does not move). Sea-stab true trails advance O0 once per antenna rotation by the tidal set/drift vector (computed from the ownship COG/SOG/HDG/STW via SetRadarOwnShipNav), so a water-fixed target accumulates in one cell while a ground-fixed target draws a trail against the set/drift. More...
enum	GroundingCheckDataSourceProperties { kGroundingCheckDataSourceProperty_DrawZone, kGroundingCheckDataSourceProperty_ZonesToDrawIndex }
	Grounding check data source properties (can be also set through parameters with SetGroundingCheckResult call). More...
enum	GroundingCheckResultSetType { kGroundingCheckResultSetType_Direct, kGroundingCheckResultSetType_Clone }
	Grounding check set type. More...

Variables
static const SDKUInt64	kDataSourceFlag_UserMask = 0xFFFFFFFF00000000
	Mask for the User's flags.
static const wchar_t *	kDataSourcePredefinedName_Radar = L"radar"
	Predefined data sources. More...
static const wchar_t *	kDataSourcePredefinedName_RadarBitmap = L"radar_bitmap"
	Created automatically for the radar bitmap layer.

Detailed Description

Describes visualization data sources manager.

Copyright © The Navtor SDK 2011-2018. All Rights Reserved.

Author

The NAVTOR SDK authors.

Date

01/2018

Maintenance:

The NAVTOR SDK authors.

Enumeration Type Documentation

DataSourceParameters

enum DataSourceParameters

Data source additional parameters.

Enumerator
kDataSourceParameter_Flags	Data source flags (see enum DataSourceFlags)

DataSourceFlags

enum DataSourceFlags

Data source flags.

Enumerator
kDataSourceFlag_ChartDatabase	Chart database indicator.
kDataSourceFlag_WeatherDatabase	Weather database indicator.
kDataSourceFlag_RoutesDatabase	Routes database indicator.
kDataSourceFlag_ViewportData	Data source contains data projected to the current viewport.
kDataSourceFlag_NoProgressiveDisplay	Displays only last fully prepared data.

DataSourceProperties

enum DataSourceProperties

Data source properties.

Enumerator
kDataSourceProperty_Priority	Priority of the data source (Float).
kDataSourceProperty_UniqueNumber	Unique number of the data source (UInt32).
kDataSourceProperty_Flags	Data source flags (enum DataSourceFlags).
kDataSourceProperty_OriginalSource	Original data source reference.

RadarDataSourceProperties

enum RadarDataSourceProperties

Radar data source properties (set via SetRadarImageParameters method, retrieved via ISDKProperty).

Enumerator
kRadarDataSourceProperty_TotalRaysCount	Total number of radar image rays.
kRadarDataSourceProperty_PixelsPerRay	Length of the ray, in pixels.
kRadarDataSourceProperty_RangeNM	Radar range, in NM.
kRadarDataSourceProperty_RangeInPixels	Radar range, in pixels.
kRadarDataSourceProperty_BitmapWidth	Radar image bitmap width, in pixels.
kRadarDataSourceProperty_BitmapHeight	Radar image bitmap height, in pixels.

RadarImageProperties

enum RadarImageProperties

Radar image properties (set via SetRadarImageProperty method, retrieved via GetRadarImageProperty).

Enumerator
kRadarImageProperty_RadarHighlightRays	Number of radar rays to highlight.
kRadarImageProperty_RadarSymbolName	Name of the radar symbol.
kRadarImageProperty_RadarColorName	Main radar image color name.
kRadarImageProperty_RadarColorOpacity	Main radar image color opacity.
kRadarImageProperty_RadarTrailMode	Radar echo trails mode (0 - off, 1 - true, 2 - relative).
kRadarImageProperty_RadarTrailDecay	Radar echo trails decay factor (0.0 .. 1.0).
kRadarImageProperty_RadarTrailTime	Variable-length (time) trails duration in seconds (<0=CONT, 0=unset, >0=time-based).
kRadarImageProperty_RadarAntennaRotationPeriod	Antenna rotation period in seconds (0=unknown).
kRadarImageProperty_RadarStabilizationMode	Radar echo trails stabilization mode (see RadarStabilizationMode).

RadarStabilizationMode

enum RadarStabilizationMode

Radar echo trails stabilization mode (IEC 62388 §11.2.2.2 h). Ground-stab true trails keep the trail frame fixed to the ground (the trail origin O0 does not move). Sea-stab true trails advance O0 once per antenna rotation by the tidal set/drift vector (computed from the ownship COG/SOG/HDG/STW via SetRadarOwnShipNav), so a water-fixed target accumulates in one cell while a ground-fixed target draws a trail against the set/drift.

Enumerator
kRadarStabilizationMode_Ground	Ground-stabilized true trails (O0 fixed).
kRadarStabilizationMode_Sea	Sea-stabilized true trails (O0 follows set/drift).

GroundingCheckDataSourceProperties

enum GroundingCheckDataSourceProperties

Grounding check data source properties (can be also set through parameters with SetGroundingCheckResult call).

Enumerator
kGroundingCheckDataSourceProperty_DrawZone	Specifies if a zone should be drawn, by default on.
kGroundingCheckDataSourceProperty_ZonesToDrawIndex	Specifies which zones should be drawn.

GroundingCheckResultSetType

enum GroundingCheckResultSetType

Grounding check set type.

Enumerator
kGroundingCheckResultSetType_Direct	Take ownership of the result.
kGroundingCheckResultSetType_Clone	Extract result data.

Variable Documentation

kDataSourcePredefinedName_Radar

const wchar_t* kDataSourcePredefinedName_Radar = L"radar"

static

Predefined data sources.

Created automatically for the radar layer.