Class VectorLayer<T>
Provides a generic vector layer implementation where an input type T is expected to represent features
within the layer
Inheritance
System.Object
VectorLayer<T>
Assembly: Mars.Components.dll
Syntax
public abstract class VectorLayer<T> : AbstractDataLayer, IVectorLayer<T>, IVectorLayer, IBoundedDataLayer, IDataSet, IDisposable, IDataLayer, ILayer, IModelObject where T : IVectorFeature, new()
Type Parameters
| Name |
Description |
| T |
The concrete type implementing the IVectorFeature contract |
Constructors
VectorLayer()
Declaration
Properties
Entities
Gets all containing entity vector features on this layer.
Declaration
public IEnumerable<T> Entities { get; }
Property Value
| Type |
Description |
| IEnumerable<T> |
|
Features
Feature collection of each vector
Declaration
public ICollection<IVectorFeature> Features { get; }
Property Value
Filter
Gets or sets the selector filter function to define domain-specific conditions
to only load only a subset of
IMarsFeatures passing this predicate.
Declaration
public Func<IMarsFeature, bool> Filter { get; set; }
Property Value
| Type |
Description |
| Func<IMarsFeature, System.Boolean> |
Returns true when the feature shall be loaded into the vector,
otherwise its is skipped.
|
GeometryCollection
The collection of all containing geometries
Declaration
public GeometryCollection GeometryCollection { get; }
Property Value
| Type |
Description |
| GeometryCollection |
|
Metric
Gets or sets the distance metric used for the spatial index.
Declaration
public IMetric<double[]> Metric { get; protected set; }
Property Value
| Type |
Description |
| IMetric<System.Double[]> |
|
Methods
Explore(Double[], Double, Int32, Func<T, Boolean>)
Executes a point query at the specified position to get all limited order of features
inside the radius in kilometre. Optional it can be filtered by a predicate over attribute table
Declaration
public IOrderedEnumerable<NodeDistance<K2dTreeNode<T>>> Explore(double[] position, double radius = null, int count = null, Func<T, bool> predicate = null)
Parameters
| Type |
Name |
Description |
| System.Double[] |
position |
The outgoing position (lat, lon) from which to start the query. |
| System.Double |
radius |
The exploration radius in meter or -1 for infinite. |
| System.Int32 |
count |
The maximum amount of features to query or -1 for infinite. |
| Func<T, System.Boolean> |
predicate |
The optional predicate to filter out specific features |
Returns
| Type |
Description |
| IOrderedEnumerable<NodeDistance<K2dTreeNode<T>>> |
A collection with distance based order of the explored features. |
FindAnyWithinRadius(Position, Double)
Finds a random T within radius around given position.
Declaration
protected T FindAnyWithinRadius(Position position, double radius)
Parameters
| Type |
Name |
Description |
| Position |
position |
From where to explore. |
| System.Double |
radius |
Maximal distance in m to position. |
Returns
| Type |
Description |
| T |
Any T in range, null if none was found. |
FindAnyWithinRadius(Position, Double, out T, Func<T, Boolean>)
Declaration
protected bool FindAnyWithinRadius(Position position, double radius, out T any, Func<T, bool> predicate = null)
Parameters
| Type |
Name |
Description |
| Position |
position |
|
| System.Double |
radius |
|
| T |
any |
|
| Func<T, System.Boolean> |
predicate |
|
Returns
| Type |
Description |
| System.Boolean |
|
InitLayer(LayerInitData, RegisterAgent, UnregisterAgent)
Declaration
public virtual bool InitLayer(LayerInitData layerInitData, RegisterAgent registerAgentHandle = null, UnregisterAgent unregisterAgentHandle = null)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
SerializeFeaturesJson()
Serialize all feature individually and returns the feature set. This means it can be added to an
existing layer in multi-layer GeoJson collection.
Declaration
public IEnumerable<string> SerializeFeaturesJson()
Returns
| Type |
Description |
| IEnumerable<System.String> |
All features with data table in JSON |
SerializeJson()
Writes the DataTable back to the original structure and returns it as JSON.
This operation is not thread safe, so don't call this function in parallel, e.g. in the agent logic.
It is meant to be used for result output between ticks.
Declaration
public string SerializeJson()
Returns
| Type |
Description |
| System.String |
All features with data table in JSON |
SetCurrentTick(Int64)
Sets the current simulation step of the layer.
This will be called by the Executor to
deliver the current logical simulation step into the layer.
Declaration
public virtual void SetCurrentTick(long currentStep)
Parameters
| Type |
Name |
Description |
| System.Int64 |
currentStep |
A positive number |
Implements
IDisposable