Detailed Description

Units are meters.

S52 Dynamic Renderer requires information from the application to be able to draw many of the S57 features. This class provides the application with this capability.

Public Member Functions
virtual	~TSLS52StateObject ()

virtual bool	CENTRE_SYMBOLS () const =0

virtual bool	CONTOUR_LABELS () const =0

virtual TSLTimeType	CURRENT_DATE () const =0

virtual int	CURRENT_SCALE () const =0

virtual double	DEEP_CONTOUR () const =0

virtual bool	DISPLAY_AT_ALL_DATES () const =0

virtual bool	DISPLAY_AT_ALL_SCALES () const =0

virtual int	DISPLAY_CATEGORY_MASK () const =0

virtual bool	DISPLAY_OVERSCALE_PATTERN () const =0

virtual int	DISTANCE_TAGS () const =0

virtual bool	FULL_SECTORS () const =0

virtual bool	LIGHT_DESCRIPTIONS () const =0

virtual bool	LOW_ACCURACY_SYMBOLS () const =0

virtual TSLCoord	OWNSHIP () const =0

virtual bool	RADAR_ON () const =0

virtual double	SAFETY_CONTOUR () const =0

virtual double	SAFETY_DEPTH () const =0

virtual double	SHALLOW_CONTOUR () const =0

virtual bool	SHALLOW_PATTERN () const =0

virtual bool	SHIPS_OUTLINE () const =0

virtual bool	SHOW_SHALLOW_DANGERS () const =0

virtual bool	SHOW_SYMBOLS () const =0

virtual bool	SHOW_TEXT () const =0

virtual bool	SHOW_TEXT_HALO () const =0

virtual bool	SIMPLE_SYMBOLS () const =0

virtual bool	SIMPLE_AREAS () const =0

virtual double	TIME_TAGS () const =0

virtual bool	TWO_SHADES () const =0

virtual TSLS52DisplayTextEnum	TEXT_DISPLAY () const =0

virtual bool	VALIDATE_HO_DATA (const char datasetName, const char datasetAgency) const =0

virtual bool	VIEWING_GROUP_DISABLED (int viewingGroup) const =0

virtual double	ZERO_CONTOUR () const =0

virtual TSLS52StateObject *	clone () const =0

Constructor & Destructor Documentation

◆ ~TSLS52StateObject()

virtual TSLS52StateObject::~TSLS52StateObject ( )

virtual

Member Function Documentation

◆ CENTRE_SYMBOLS()

virtual bool TSLS52StateObject::CENTRE_SYMBOLS ( ) const

pure virtual

This method should return true if symbols should be dynamically shifted to the centre of S57 features as the map is navigated.

◆ clone()

virtual TSLS52StateObject * TSLS52StateObject::clone ( ) const

pure virtual

◆ CONTOUR_LABELS()

virtual bool TSLS52StateObject::CONTOUR_LABELS ( ) const

pure virtual

This method should return true if contour labels are to be displayed on S57 depth contour objects.

◆ CURRENT_DATE()

virtual TSLTimeType TSLS52StateObject::CURRENT_DATE ( ) const

pure virtual

This method should return the date which will be used to determine which seasonal objects should be displayed.

In most cases the current date should be returned.

◆ CURRENT_SCALE()

virtual int TSLS52StateObject::CURRENT_SCALE ( ) const

pure virtual

This method should return the current view scale.

This value will be used to calculate whether or not the current view contains overscaled data.

◆ DEEP_CONTOUR()

virtual double TSLS52StateObject::DEEP_CONTOUR ( ) const

pure virtual

This method should return the value of the current deep contour.

◆ DISPLAY_AT_ALL_DATES()

virtual bool TSLS52StateObject::DISPLAY_AT_ALL_DATES ( ) const

pure virtual

Returning true in this method will display all S57 features, regardless of whether or not they are outside their valid date range.

It is recommended that this value returns false by default.

◆ DISPLAY_AT_ALL_SCALES()

virtual bool TSLS52StateObject::DISPLAY_AT_ALL_SCALES ( ) const

pure virtual

Returning true in this method will display all S57 features, regardless of whether or not they are outside their valid scale range.

It is recommended that this value returns false by default.

◆ DISPLAY_CATEGORY_MASK()

virtual int TSLS52StateObject::DISPLAY_CATEGORY_MASK ( ) const

pure virtual

This method should return an integer mask which will determine which S52 display categories are visible when rendering S52.

The mask should be constructed using the values stored in the TSLS52Display CategoryEnum enumeration.

◆ DISPLAY_OVERSCALE_PATTERN()

virtual bool TSLS52StateObject::DISPLAY_OVERSCALE_PATTERN ( ) const

pure virtual

If this method returns true then the over scale pattern 'OVERSC01' is displayed when an overscale indication is required to be drawn (see DATCVR02).

◆ DISTANCE_TAGS()

virtual int TSLS52StateObject::DISTANCE_TAGS ( ) const

pure virtual

This method should return the selected spacing of "distance to run" tags at a route.

◆ FULL_SECTORS()

virtual bool TSLS52StateObject::FULL_SECTORS ( ) const

pure virtual

This method will determine whether or not lights will be shown with full sector lines.

Returning true will display lights with full sector lines.

◆ LIGHT_DESCRIPTIONS()

virtual bool TSLS52StateObject::LIGHT_DESCRIPTIONS ( ) const

pure virtual

This method will determine whether or not light descriptions are generated when S57 LIGHTS objects appear in view.

Returning true will generate light descriptions.

◆ LOW_ACCURACY_SYMBOLS()

virtual bool TSLS52StateObject::LOW_ACCURACY_SYMBOLS ( ) const

pure virtual

This method will determine whether or not low accuracy symbols are shown on data which is deemed to be of low accuracy.

Returning true will display low accuracy symbols.

◆ OWNSHIP()

virtual TSLCoord TSLS52StateObject::OWNSHIP ( ) const

pure virtual

This method should return the location of the OWNSHIP feature.

◆ RADAR_ON()

virtual bool TSLS52StateObject::RADAR_ON ( ) const

pure virtual

This method should return true if the radar layer is on.

◆ SAFETY_CONTOUR()

virtual double TSLS52StateObject::SAFETY_CONTOUR ( ) const

pure virtual

This method should return the value of the safety contour.

◆ SAFETY_DEPTH()

virtual double TSLS52StateObject::SAFETY_DEPTH ( ) const

pure virtual

This method should return the value of the current safety depth.

◆ SHALLOW_CONTOUR()

virtual double TSLS52StateObject::SHALLOW_CONTOUR ( ) const

pure virtual

This method should return the value of the current shallow contour.

◆ SHALLOW_PATTERN()

virtual bool TSLS52StateObject::SHALLOW_PATTERN ( ) const

pure virtual

This method determines whether or not the additional shallow area pattern is displayed on areas which are deemed to be shallow.

Returning true will display the shallow pattern on top of shallow areas.

◆ SHIPS_OUTLINE()

virtual bool TSLS52StateObject::SHIPS_OUTLINE ( ) const

pure virtual

◆ SHOW_SHALLOW_DANGERS()

virtual bool TSLS52StateObject::SHOW_SHALLOW_DANGERS ( ) const

pure virtual

This method should return true if shallow dangers are to be displayed as an underwater hazard.

◆ SHOW_SYMBOLS()

virtual bool TSLS52StateObject::SHOW_SYMBOLS ( ) const

pure virtual

This method should return true if the user wants symbols to be rendered in the S52 display.

◆ SHOW_TEXT()

virtual bool TSLS52StateObject::SHOW_TEXT ( ) const

pure virtual

This method should return true if the user wants text to be rendered in the S52 display.

◆ SHOW_TEXT_HALO()

virtual bool TSLS52StateObject::SHOW_TEXT_HALO ( ) const

pure virtual

This method should return true if the user wants text to be rendered with a visible halo in the S52 display.

◆ SIMPLE_AREAS()

virtual bool TSLS52StateObject::SIMPLE_AREAS ( ) const

pure virtual

This method determines whether or not paper chart or simple S52 area boundaries are displayed.

Returning true will display simple S52 area boundaries.

◆ SIMPLE_SYMBOLS()

virtual bool TSLS52StateObject::SIMPLE_SYMBOLS ( ) const

pure virtual

This method determines whether or not paper chart or simple S52 symbols are displayed.

Returning true will display simple S52 symbols.

◆ TEXT_DISPLAY()

virtual TSLS52DisplayTextEnum TSLS52StateObject::TEXT_DISPLAY ( ) const

pure virtual

This method determines what type of text should be displayed, based on the returned enum.

Returning TSLS52DisplayText_None will display no text. Returning TSLS52DisplayText_Important will display only important text. Returning TSLS52DisplayText_All will display all text.

◆ TIME_TAGS()

virtual double TSLS52StateObject::TIME_TAGS ( ) const

pure virtual

This method determines the selected spacing of time tags at the past track.

◆ TWO_SHADES()

virtual bool TSLS52StateObject::TWO_SHADES ( ) const

pure virtual

This method determines whether depth areas are displayed using four colours or two colours.

Returning true will display depth areas in two colours.

◆ VALIDATE_HO_DATA()

virtual bool TSLS52StateObject::VALIDATE_HO_DATA	(	const char *	datasetName,
		const char *	datasetAgency ) const

pure virtual

This method should be used to determine whether or not the supplied dataset name and producing agency can be considered to be valid hydrographic office data.

Returning true confirms the dataset and agency can be considered to be valid HO data.

◆ VIEWING_GROUP_DISABLED()

virtual bool TSLS52StateObject::VIEWING_GROUP_DISABLED ( int viewingGroup ) const

pure virtual

This method should be used to determine whether or not the supplied viewing group should be displayed.

Returning true will ensure the viewing group is not displayed.

◆ ZERO_CONTOUR()

virtual double TSLS52StateObject::ZERO_CONTOUR ( ) const

pure virtual

This method should return the value which is considered to be the zero contour.

It is recommended that by default this method should return 0.0.

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ ~TSLS52StateObject()

Member Function Documentation

◆ CENTRE_SYMBOLS()

◆ clone()

◆ CONTOUR_LABELS()

◆ CURRENT_DATE()

◆ CURRENT_SCALE()

◆ DEEP_CONTOUR()

◆ DISPLAY_AT_ALL_DATES()

◆ DISPLAY_AT_ALL_SCALES()

◆ DISPLAY_CATEGORY_MASK()

◆ DISPLAY_OVERSCALE_PATTERN()

◆ DISTANCE_TAGS()

◆ FULL_SECTORS()

◆ LIGHT_DESCRIPTIONS()

◆ LOW_ACCURACY_SYMBOLS()

◆ OWNSHIP()

◆ RADAR_ON()

◆ SAFETY_CONTOUR()

◆ SAFETY_DEPTH()

◆ SHALLOW_CONTOUR()

◆ SHALLOW_PATTERN()

◆ SHIPS_OUTLINE()

◆ SHOW_SHALLOW_DANGERS()

◆ SHOW_SYMBOLS()

◆ SHOW_TEXT()

◆ SHOW_TEXT_HALO()

◆ SIMPLE_AREAS()

◆ SIMPLE_SYMBOLS()

◆ TEXT_DISPLAY()

◆ TIME_TAGS()

◆ TWO_SHADES()

◆ VALIDATE_HO_DATA()

◆ VIEWING_GROUP_DISABLED()

◆ ZERO_CONTOUR()