portrayal_parameters_interface.h

Go to the documentation of this file.

 
#ifndef SDK_PORTRAYAL_PARAMETERS_INTERFACE_H_
#define SDK_PORTRAYAL_PARAMETERS_INTERFACE_H_
 
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
 
namespace sdk {
namespace vis {
 
FWD_DECL_INTERFACE(IPortrayalParameters)
FWD_DECL_INTERFACE(IPortrayalParametersEnumerator)
 
 
static const SDKUInt32 kPortrayalParameters_OwnShip  =   1000UL;
static const SDKUInt32 kPortrayalParameters_ARPA     =   2000UL;
static const SDKUInt32 kPortrayalParameters_AIS      =   3000UL;
static const SDKUInt32 kPortrayalParameters_AIO      =   4000UL;
static const SDKUInt32 kPortrayalParameters_Other    =   5000UL;
static const SDKUInt32 kPortrayalParameters_Internal = 100000UL;
 
enum PortrayalParameterEnum
{
  kPP_First = 0,
  kPP_ShallowContour = kPP_First,            
  kPP_DeepContour,                           
  kPP_SafetyContour,                         
  kPP_SafetyDepth,                           
  kPP_ShallowPattern,                        
  kPP_PaperChartSymbols,                     
  kPP_SymbolisedBoundaries,                  
  kPP_ColourMode,                            
  kPP_DisplayPalette,                        
  kPP_SymbolsAndTextScale,                   
  kPP_DangerInShallowWaters,                 
  kPP_AntiAliasingMode,                      
  kPP_TextAntiAliasingMode,                  
  kPP_RealLengthLightSectorLegs,             
  kPP_UseLocalScaleForChartsSelection,       
  kPP_UsePeriodicAttributes,                 
  kPP_UseScaminScamaxAttributes,             
  kPP_TextDeconflicting,                     
  kPP_ShowGridlines,                         
  kPP_Flashing,                              
  kPP_S101_Portrayal,                        
  kPP_ContextTime,                           
  kPP_TimeLimitedObjectsStartTime,           
  kPP_TimeLimitedObjectsEndTime,             
  kPP_SafetyContourColor,                    
  kPP_OverscaleIndicationScaleFactor,        
  kPP_OverscaleIndicationAlgorithm,          
  kPP_ScaleBarPosition,                      
  kPP_DepthUnitsPosition,                    
  kPP_NorthUpIndicatorPosition,              
  kPP_ScaleIndicatorPosition,                
  kPP_DangerSymbolOn,                        
  kPP_DecorationTextColorName,               
  kPP_DecorationTextHeight,                  
  kPP_SafeHazardsShown,                      
  kPP_SafeDepthsShown,                       
  kPP_CentralSymbolsExcludeZone,             
  kPP_CentralSymbolsExcludeVessel,           
  kPP_CentralSymbolsAlgorithm,               
  kPP_DepthUnits,                            
  kPP_DistanceUnits,                         
  kPP_Gridlines_Flags,                       
  kPP_Gridlines_Parameters,                  
  kPP_VesselGeoPosition,                     
  kPP_ReviewMode,                            
  kPP_DontUseTransparency,                   
  kPP_UseIEC62288ed2,                        
  kPP_HighlightDateDependentObjects,         
  kPP_UseNationalAttributes,                 
  kPP_FullLightsInfo,                        
  kPP_ReviewStartTime,                       
  kPP_ReviewEndTime,                         
  kPP_RealLengthLightLegs_ExtraLightsOn,     
  kPP_RealLengthLightLegs_ActivationScale,   
  kPP_RealLengthLightLegs_ExtendSizeNM,      
  kPP_GroundingCheck_CombineSCAreasHighlight,
  kPP_Temp_MakeObstructionInUNSAREDangerous, 
  kPP_ShowParallelIndexLinesOnActiveRoute,   
  kPP_ShowPositionReferencesOnActiveRoute,   
  kPP_WPNumbering,                           
  kPP_DetailedNoticeMarks,                   
  kPP_UseOverRadarFlag,                      
  kPP_DontUseAIOHatches,                     
  kPP_VesselLength,                          
  kPP_ShowEventMarkID,                       
  kPP_Max,
};
 
static const char* kPortrayalParameterName[] = 
{
  "ShallowContour",                             
  "DeepContour",                                
  "SafetyContour",                              
  "SafetyDepth",                                
  "ShallowPattern",                             
  "PaperChartSymbols",                          
  "SymbolisedBoundaries",                       
  "ColourMode",                                 
  "DisplayPalette",                             
  "SymbolsAndTextScale",                        
  "DangerInShallowWaters",                      
  "AntiAliasingMode",                           
  "TextAntiAliasingMode",                       
  "RealLengthLightSectorLegs",                  
  "UseLocalScaleForChartsSelection",            
  "UsePeriodicAttributes",                      
  "UseScaminScamaxAttributes",                  
  "TextDeconflicting",                          
  "ShowGridlines",                              
  "Flashing",                                   
  "S101_Portrayal",                             
  "ContextTime",                                
  "TimeLimitedObjectsStartTime",                
  "TimeLimitedObjectsEndTime",                  
  "SafetyContourColor",                         
  "OverscaleIndicationScaleFactor",             
  "OverscaleIndicationAlgorithm",               
  "ScaleBarPosition",                           
  "DepthUnitsPosition",                         
  "NorthUpArrowPosition",                       
  "ScaleIndicatorPosition",                     
  "DangerSymbolOn",                             
  "DecorationTextColorName",                    
  "DecorationTextHeight",                       
  "SafeHazardsShown",                           
  "SafeDepthsShown",                            
  "CentralSymbolsExcludeZone",                  
  "CentralSymbolsExcludeVessel",                
  "CentralSymbolsAlgorithm",                    
  "DepthUnits",                                 
  "DistanceUnits",                              
  "Gridlines_Flags",                            
  "Gridlines_Parameters",                       
  "VesselGeoPosition",                          
  "ReviewMode",                                 
  "DontUseTransparency",                        
  "UseIEC62288ed2",                             
  "HighlightDateDependentObjects",              
  "UseNationalAttributes",                      
  "FullLightsInfo",                             
  "ReviewStartTime",                            
  "ReviewEndTime",                              
  "RealLengthLightLegs_ExtraLightsOn",          
  "RealLengthLightLegs_ActivationScale",        
  "RealLengthLightLegs_ExtendSizeNM",           
  "GroundingCheck_CombineSCAreasHighlight",     
  "Temp_MakeObstructionInUNSAREDangerous",      
  "ShowParallelIndexLinesOnActiveRoute",        
  "ShowPositionReferencesOnActiveRoute",        
  "WPNumbering",                                
  "DetailedNoticeMarks",                        
  "UseOverRadarFlag",                           
  "DontUseAIOHatches",                          
  "VesselLength",                               
  "ShowEventMarkID",                            
};
 
enum DangerInShallowWatersEnum
{
  kPP_DangerInShallowWaters_Not_Display = 0, 
  kPP_DangerInShallowWaters_Display     = 1, 
};
 
enum PortrayalParameterColourModeEnum
{
  kPP_ColourMode_4Colour = 0, 
  kPP_ColourMode_2Colour = 1, 
  kPP_ColourMode_1Colour = 2  
};
 
enum PortrayalParameterBoundariesModeEnum
{
  kPP_PlainBoundariesMode = 0, 
  kPP_SymbolisedBoundariesMode 
};
 
enum PortrayalParameterOverscaleIndicationAlgorithmEnum
{
  kPP_OverscaleIndicationAlgorithm_S52 = 0,
  kPP_OverscaleIndicationAlgorithm_Alternative = 1, 
};
 
enum PortrayalParameterCentralSymbolsAlgorithmEnum
{
  kPP_CentralSymbolsAlgorithm_Simple = 0,  
  kPP_CentralSymbolsAlgorithm_Complex = 1, 
};
 
enum GridlinesFlagsEnum
{
  kPP_GridlinesFlags_EqualStepLat          = 0x0001, 
  kPP_GridlinesFlags_EqualStepLon          = 0x0002, 
  kPP_GridlinesFlags_EqualStepMin          = 0x0004, 
  kPP_GridlinesFlags_HideRotated           = 0x0010, 
  kPP_GridlinesFlags_RotatedLabelsAtCenter = 0x0020, 
  kPP_GridlinesFlags_LabelsAtCenter        = 0x0100, 
  kPP_GridlinesFlags_LabelsBothSides       = 0x0200, 
};
 
enum GridlinesParametersEnum
{
  kPP_GridlinesParameters_FixedLatStep,         
  kPP_GridlinesParameters_FixedLonStep,         
  kPP_GridlinesParameters_MaxStepInMeters,      
  kPP_GridlinesParameters_MaxStepInPixels,      
  kPP_GridlinesParameters_MinLinesCount,        
  kPP_GridlinesParameters_SideMarkerAlignLeft,  
  kPP_GridlinesParameters_MarkerTextSize,       
  kPP_GridlinesParameters_BottomBorderShiftPx,  
  kPP_GridlinesParameters_BottomBorderShiftTmm, 
};
 
enum ReviewModeEnum
{
  kPP_ReviewMode_Off                   = 0, 
  kPP_ReviewMode_DisplayReviewedOnly   = 1, 
  kPP_ReviewMode_HighlightReviewedOnly = 2, 
};
 
union PositionInScene
{
  SDKUInt64 m_position;
  struct
  {
    SDKUInt32 m_left;
    SDKUInt32 m_top;
  };
};
 
#if defined(__cplusplus)
static inline SDKUInt64 PositionInSceneInit(SDKUInt32 left, SDKUInt32 top)
{
  PositionInScene pos; pos.m_left = left; pos.m_top = top;
  return pos.m_position;
}
#else
#define PositionInSceneInit(left, top) \
  ((left & 0x00000000FFFFFFFFULL) | \
  ((static_cast<SDKUInt64>(top) << 32) & 0xFFFFFFFF00000000ULL))
#endif 
 
enum SymbolsAndTextScaleEnum
{
  kPP_SymbolsAndTextScale_AidsToNavigation = 0, 
  kPP_SymbolsAndTextScale_LightDescription,     
  kPP_SymbolsAndTextScale_NoteOnChart,          
  kPP_SymbolsAndTextScale_NatureOfSeabed,       
  kPP_SymbolsAndTextScale_GeographicNames,      
  kPP_SymbolsAndTextScale_MarinersText,         
  kPP_SymbolsAndTextScale_ManufacturersText,    
  kPP_SymbolsAndTextScale_AllTexts,             
};
 
enum UseLocalScaleForChartsSelectionEnum
{
  kPP_UseLocalScaleForChartsSelection_Off = 0,      
  kPP_UseLocalScaleForChartsSelection_UserPosition, 
  kPP_UseLocalScaleForChartsSelection_SceneCenter,  
  kPP_UseLocalScaleForChartsSelection_SceneProperty 
};
 
 
static const char kParametersCatalog_VersionKey[] =
  "format_version";
static const char kParametersCatalog_DatasetPropertiesKey[] = 
  "dataset_properties";
static const char kParametersCatalog_PortrayalParametersKey[] = 
  "portrayal_parameters";
static const char kParametersCatalog_Name[] = "name";
static const char kParametersCatalog_Code[] = "code";
static const char kParametersCatalog_DefaultValue[] = "default_value";
static const char kParametersCatalog_MinimumValue[] = "minimum_value";
static const char kParametersCatalog_MaximumValue[] = "maximum_value";
static const char kParametersCatalog_ListedValues[] = "listed_values";
static const char kParametersCatalog_MeasurementType[] = "measurement_type";
static const char kParametersCatalog_DecimalsNumber[] = "decimals";
 
static const SDKInt32 kParametersCatalog_DecimalsNumber_Undefined = -1;
 
class IPortrayalParameters : public ISDKParameters
{
public:
  // ISDKParameters
  //virtual SDKResult SDK_CALLTYPE GetParameter(
  //  SDKParameterID param, SDKAny& value) const throw() = 0;
  //virtual SDKResult SDK_CALLTYPE SetParameter(
  //  SDKParameterID param, const SDKAny& value) throw() = 0;
 
  SDK_IMPLEMENT_IID(IPortrayalParameters)
  SDK_END_INTERFACE(IPortrayalParameters)
};
SDK_DECLARE_IID(IPortrayalParameters)
 
class IPortrayalParametersEnumerator : public ISDKComponent
{
public:
  virtual SDKResult Next(SDKParameterID& parameter_id, SDKAny& value) const throw() = 0;
  virtual SDKResult Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IPortrayalParametersEnumerator)
  SDK_END_INTERFACE(IPortrayalParametersEnumerator)
};
SDK_DECLARE_IID(IPortrayalParametersEnumerator)
 
} // namespace vis
} // namespace sdk
 
#endif // SDK_PORTRAYAL_PARAMETERS_INTERFACE_H_