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
DisposeBase
BoundDataSet
AbstractDataLayer
VectorLayer<T>
VectorLayer
Implements
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Mars.Components.Layers
Assembly: Mars.Components.dll
Syntax
public abstract class VectorLayer<T> : AbstractDataLayer, IEnumerable<T>, IEnumerable, IVectorLayer<T>, IVectorLayer, IBoundedDataLayer, IDataSet, IDisposable, IDataLayer, IChangingLayer, ILayer, IModelObject, INotifyChangedSource<IVectorFeature> where T : IVectorFeature, new()
Type Parameters
Name Description
T The concrete type implementing the IVectorFeature contract

Constructors

VectorLayer()

Declaration
protected VectorLayer()

Properties

Extent

Gets the bounding box of this vector-layer.
Declaration
public override BoundingBox Extent { get; set; }
Property Value
Type Description
BoundingBox
Overrides

Features

Feature collection of each vector
Declaration
public ICollection<IVectorFeature> Features { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<IVectorFeature>

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
System.Func<IMarsFeature, System.Boolean> Returns true when the feature shall be loaded into the vector, otherwise its is skipped.

IsChanged

Declaration
public bool IsChanged { get; set; }
Property Value
Type Description
System.Boolean

NearestOperationPlatform

Declaration
public INearestOperation NearestOperationPlatform { get; }
Property Value
Type Description
INearestOperation

Methods

Explore(Double[], Double, 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 IEnumerable<T> Explore(double[] position, double radius = -1, 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.Func<T, System.Boolean> predicate The optional predicate to filter out specific features
Returns
Type Description
System.Collections.Generic.IEnumerable<T> A collection with distance based order of the explored features.

GetEnumerator()

Declaration
public IEnumerator<T> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<T>

InitLayer(LayerInitData, RegisterAgent, UnregisterAgent)

Declaration
public virtual bool InitLayer(LayerInitData layerInitData, RegisterAgent registerAgentHandle = null, UnregisterAgent unregisterAgent = null)
Parameters
Type Name Description
LayerInitData layerInitData
RegisterAgent registerAgentHandle
UnregisterAgent unregisterAgent
Returns
Type Description
System.Boolean

Insert(IDomainData)

Declaration
public T Insert(IDomainData data)
Parameters
Type Name Description
IDomainData data
Returns
Type Description
T

Nearest(Double[], Func<T, Boolean>)

Tries to find the nearest domain object for given parameters.
Declaration
public T Nearest(double[] position, Func<T, bool> predicate = null)
Parameters
Type Name Description
System.Double[] position The outgoing position (lat, lon) from which to start the query.
System.Func<T, System.Boolean> predicate The optional predicate to filter out specific features
Returns
Type Description
T The found T or null if none could be found.

Nearest(Double[], Int32, Func<T, Boolean>)

Tries to find the k-nearest domain object for given parameters.
Declaration
public IEnumerable<T> Nearest(double[] position, int k, Func<T, bool> predicate = null)
Parameters
Type Name Description
System.Double[] position The outgoing position (lat, lon) from which to start the query.
System.Int32 k The k-limitation of objects to retrieve.
System.Func<T, System.Boolean> predicate The optional predicate to filter out specific features
Returns
Type Description
System.Collections.Generic.IEnumerable<T> The found T or null if none could be found.

Read(Double[])

Reads the value exactly at the specified coordinate; otherwise returns the default of .
Declaration
public T Read(double[] position)
Parameters
Type Name Description
System.Double[] position The coordinate to read from.
Returns
Type Description
T Returns the data object at the specified coordinate; otherwise null.

Region(Double[], Double, Func<T, Boolean>)

Finds a randomly selected entity within region, given by the radius and position.
Declaration
public IEnumerable<T> Region(double[] position, double radius, Func<T, bool> predicate = null)
Parameters
Type Name Description
System.Double[] position Source position from where to explore.
System.Double radius The maximum distance in to this position (For GIS based data often in meter).
System.Func<T, System.Boolean> predicate An optional predicate used filter out a specific data object.
Returns
Type Description
System.Collections.Generic.IEnumerable<T> Returns true, when any entity was found; otherwise false.

Remove(T)

Declaration
public void Remove(T entity)
Parameters
Type Name Description
T entity

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

Events

CollectionChanged

Occurs when items were added, replaced or removed.
Declaration
public event EventHandler<CollectionChangedEventArgs<IVectorFeature>> CollectionChanged
Event Type
Type Description
System.EventHandler<CollectionChangedEventArgs<IVectorFeature>>

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
System.IDisposable