S52ViewingGroupFilter Class

Specifies which layers of S52 viewing groups that are visible.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public class S52ViewingGroupFilter : ResourceObject

Remarks

An instance of this class can be used as an S52Visualizer.ViewingGroupFilter to give more fine-grained filtering of object visibility than the coarser S52Visualizer.DisplayCategory allows.

The fine-grained control works on so-called layers. The S-52 visualizations are aggregated into viewing groups, which are aggregated into viewing group layers. For each layer, this class has a property that can decide whether or not the viewing groups in the layer are visible. The property value can be Hidden, Visible or Auto (see S52ViewingGroupVisibility), where the Auto value lets the visibility be decided by the S52Visualizer.DisplayCategory.

The ViewingGroupOverride property allows an even finer control, where you can specify the visibility of individual viewing groups.

Note that S-57 data come in two flavors, ENC and AML:

For S-57 ENC data, this class controls all the available viewing group layers.
For S-57 AML data (Additional Military Layers), there are some more viewing group layers, which you can control by using an instance of the derived class S52AmlViewingGroupFilter.

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      S52ViewingGroupFilter
        S52AmlViewingGroupFilter

Platforms

Windows, Linux, Android

S52ViewingGroupFilter Members

The S52ViewingGroupFilter type has the following members.

Constructors

Name	Description
S52ViewingGroupFilter	Initializes a new instance of the S52ViewingGroupFilter.

Properties

Name	Description
ArchipelagicSeaLanes	Gets or sets a value that controls the display of archipelagic sea lanes.
BoundariesLimits	Gets or sets a value that controls the display of boundaries and limits.
BuoysBeaconsNavaids	Gets or sets a value that controls the display of buoys, beacons and aids to navigation.
BuoysBeaconsStructures	Gets or sets a value that controls the display of buoys, beacons and structures.
CautionaryNotes	Gets or sets a value that controls the display of cautionary notes.
DepthContours	Gets or sets a value that controls the display of depth contours.
DryingLine	Gets or sets a value that controls the display of drying lines.
IsDisposed	Gets a value that tells whether the current S52ViewingGroupFilter has been disposed. Inherited from EngineObject
IsolatedDangers	Gets or sets a value that controls the display of isolated dangers.
Lights	Gets or sets a value that controls the display of lights.
MagneticVariation	Gets or sets a value that controls the display of magnetic variation.
MiscellaneousOther	Gets or sets a value that controls the display of miscellaneous features in display category 'Other'.
MiscellaneousStandard	Gets or sets a value that controls the display of miscellaneous features in display category 'Standard'.
Name	Gets or sets the name of the S52ViewingGroupFilter. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current S52ViewingGroupFilter represents. Inherited from EngineObject
ProhibitedRestrictedAreas	Gets or sets a value that controls the display of prohibited and restricted areas.
Routing	Gets or sets a value that controls the display of ships' routing systems and ferry lines.
Seabed	Gets or sets a value that controls the display of seabed features.
Soundings	Gets or sets a value that controls the display of soundings.
SubmarineCablesPipelines	Gets or sets a value that controls the display of submarine cables and pipelines.
Tidal	Gets or sets a value that controls the display of tidal features.
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
ViewingGroupOverride	Gets or sets a value that controls the display of individual viewing groups.

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject

S52ViewingGroupFilter Class

Specifies which layers of S52 viewing groups that are visible.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class S52ViewingGroupFilter : public ResourceObject

C++ Smart Pointer Declaration

typedef Ptr<S52ViewingGroupFilter> S52ViewingGroupFilterPtr;

Remarks

An instance of this class can be used as an S52Visualizer::viewingGroupFilter to give more fine-grained filtering of object visibility than the coarser S52Visualizer::displayCategory allows.

The viewingGroupOverride property allows an even finer control, where you can specify the visibility of individual viewing groups.

Note that S-57 data come in two flavors, ENC and AML:

For S-57 ENC data, this class controls all the available viewing group layers.
For S-57 AML data (Additional Military Layers), there are some more viewing group layers, which you can control by using an instance of the derived class S52AmlViewingGroupFilter.

Inheritance Hierarchy

EngineObject
  ResourceObject
    S52ViewingGroupFilter
      S52AmlViewingGroupFilter

Platforms

Windows, Linux, Android

S52ViewingGroupFilter Members

The S52ViewingGroupFilter type has the following members.

Constructors

Name	Description
S52ViewingGroupFilter	Initializes a new instance of the S52ViewingGroupFilter.

Properties

Name	Description
archipelagicSeaLanes	Gets or sets a value that controls the display of archipelagic sea lanes.
boundariesLimits	Gets or sets a value that controls the display of boundaries and limits.
buoysBeaconsNavaids	Gets or sets a value that controls the display of buoys, beacons and aids to navigation.
buoysBeaconsStructures	Gets or sets a value that controls the display of buoys, beacons and structures.
cautionaryNotes	Gets or sets a value that controls the display of cautionary notes.
depthContours	Gets or sets a value that controls the display of depth contours.
dryingLine	Gets or sets a value that controls the display of drying lines.
isolatedDangers	Gets or sets a value that controls the display of isolated dangers.
lights	Gets or sets a value that controls the display of lights.
magneticVariation	Gets or sets a value that controls the display of magnetic variation.
miscellaneousOther	Gets or sets a value that controls the display of miscellaneous features in display category 'Other'.
miscellaneousStandard	Gets or sets a value that controls the display of miscellaneous features in display category 'Standard'.
name	Gets or sets the name of the S52ViewingGroupFilter. Inherited from ResourceObject
prohibitedRestrictedAreas	Gets or sets a value that controls the display of prohibited and restricted areas.
routing	Gets or sets a value that controls the display of ships' routing systems and ferry lines.
seabed	Gets or sets a value that controls the display of seabed features.
soundings	Gets or sets a value that controls the display of soundings.
submarineCablesPipelines	Gets or sets a value that controls the display of submarine cables and pipelines.
tidal	Gets or sets a value that controls the display of tidal features.
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
viewingGroupOverride	Gets or sets a value that controls the display of individual viewing groups.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

S52ViewingGroupFilter Class

Specifies which layers of S52 viewing groups that are visible.

Package: com.carmenta.engine.core
JAR file: CECore.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class S52ViewingGroupFilter extends ResourceObject

Remarks

An instance of this class can be used as an S52Visualizer.viewingGroupFilter to give more fine-grained filtering of object visibility than the coarser S52Visualizer.displayCategory allows.

The viewingGroupOverride property allows an even finer control, where you can specify the visibility of individual viewing groups.

Note that S-57 data come in two flavors, ENC and AML:

For S-57 ENC data, this class controls all the available viewing group layers.
For S-57 AML data (Additional Military Layers), there are some more viewing group layers, which you can control by using an instance of the derived class S52AmlViewingGroupFilter.

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    ResourceObject
      S52ViewingGroupFilter
        S52AmlViewingGroupFilter

Platforms

Windows, Linux, Android

S52ViewingGroupFilter Members

The S52ViewingGroupFilter type has the following members.

Constructors

Name	Description
S52ViewingGroupFilter	Initializes a new instance of the S52ViewingGroupFilter.

Properties

Name	Description
archipelagicSeaLanes	Gets or sets a value that controls the display of archipelagic sea lanes.
boundariesLimits	Gets or sets a value that controls the display of boundaries and limits.
buoysBeaconsNavaids	Gets or sets a value that controls the display of buoys, beacons and aids to navigation.
buoysBeaconsStructures	Gets or sets a value that controls the display of buoys, beacons and structures.
cautionaryNotes	Gets or sets a value that controls the display of cautionary notes.
depthContours	Gets or sets a value that controls the display of depth contours.
dryingLine	Gets or sets a value that controls the display of drying lines.
isDisposed	Gets a value that tells whether the current S52ViewingGroupFilter has been disposed. Inherited from EngineObject
isolatedDangers	Gets or sets a value that controls the display of isolated dangers.
lights	Gets or sets a value that controls the display of lights.
magneticVariation	Gets or sets a value that controls the display of magnetic variation.
miscellaneousOther	Gets or sets a value that controls the display of miscellaneous features in display category 'Other'.
miscellaneousStandard	Gets or sets a value that controls the display of miscellaneous features in display category 'Standard'.
name	Gets or sets the name of the S52ViewingGroupFilter. Inherited from ResourceObject
prohibitedRestrictedAreas	Gets or sets a value that controls the display of prohibited and restricted areas.
routing	Gets or sets a value that controls the display of ships' routing systems and ferry lines.
seabed	Gets or sets a value that controls the display of seabed features.
soundings	Gets or sets a value that controls the display of soundings.
submarineCablesPipelines	Gets or sets a value that controls the display of submarine cables and pipelines.
tidal	Gets or sets a value that controls the display of tidal features.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
viewingGroupOverride	Gets or sets a value that controls the display of individual viewing groups.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

S52ViewingGroupFilter Class

Specifies which layers of S52 viewing groups that are visible.

Module: Carmenta.Engine.Core (in Core.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class S52ViewingGroupFilter ( ResourceObject )

Remarks

An instance of this class can be used as an S52Visualizer.viewingGroupFilter to give more fine-grained filtering of object visibility than the coarser S52Visualizer.displayCategory allows.

The viewingGroupOverride property allows an even finer control, where you can specify the visibility of individual viewing groups.

Note that S-57 data come in two flavors, ENC and AML:

For S-57 ENC data, this class controls all the available viewing group layers.
For S-57 AML data (Additional Military Layers), there are some more viewing group layers, which you can control by using an instance of the derived class S52AmlViewingGroupFilter.

Inheritance Hierarchy

EngineObject
  ResourceObject
    S52ViewingGroupFilter
      S52AmlViewingGroupFilter

Platforms

Windows, Linux, Android

S52ViewingGroupFilter Members

The S52ViewingGroupFilter type has the following members.

Constructors

Name	Description
S52ViewingGroupFilter	Initializes a new instance of the S52ViewingGroupFilter.

Properties

Name	Description
archipelagicSeaLanes	Gets or sets a value that controls the display of archipelagic sea lanes.
boundariesLimits	Gets or sets a value that controls the display of boundaries and limits.
buoysBeaconsNavaids	Gets or sets a value that controls the display of buoys, beacons and aids to navigation.
buoysBeaconsStructures	Gets or sets a value that controls the display of buoys, beacons and structures.
cautionaryNotes	Gets or sets a value that controls the display of cautionary notes.
depthContours	Gets or sets a value that controls the display of depth contours.
dryingLine	Gets or sets a value that controls the display of drying lines.
isolatedDangers	Gets or sets a value that controls the display of isolated dangers.
lights	Gets or sets a value that controls the display of lights.
magneticVariation	Gets or sets a value that controls the display of magnetic variation.
miscellaneousOther	Gets or sets a value that controls the display of miscellaneous features in display category 'Other'.
miscellaneousStandard	Gets or sets a value that controls the display of miscellaneous features in display category 'Standard'.
name	Gets or sets the name of the S52ViewingGroupFilter. Inherited from ResourceObject
prohibitedRestrictedAreas	Gets or sets a value that controls the display of prohibited and restricted areas.
routing	Gets or sets a value that controls the display of ships' routing systems and ferry lines.
seabed	Gets or sets a value that controls the display of seabed features.
soundings	Gets or sets a value that controls the display of soundings.
submarineCablesPipelines	Gets or sets a value that controls the display of submarine cables and pipelines.
tidal	Gets or sets a value that controls the display of tidal features.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
viewingGroupOverride	Gets or sets a value that controls the display of individual viewing groups.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

S52ViewingGroupFilter Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

S52ViewingGroupFilter Members

S52ViewingGroupFilter Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

S52ViewingGroupFilter Members

S52ViewingGroupFilter Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

S52ViewingGroupFilter Members

S52ViewingGroupFilter Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

S52ViewingGroupFilter Members