Class LayerAdapter

Represents an adapter that adapts a layer to a certain set of devices using IAdaptionHints

Inheritance
object
LayerAdapter
Implements
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class LayerAdapter : IStorageModel

Properties

AdaptionHints

Gets or sets a list containing the adaption hints used by this adapter

Declaration
public ReadOnlyCollection<IAdaptionHint> AdaptionHints { get; set; }
Property Value
Type Description
ReadOnlyCollection<IAdaptionHint>

Layer

Gets the layer this adapter can adapt

Declaration
public Layer Layer { get; }
Property Value
Type Description
Layer

Methods

Adapt(List<ArtemisDevice>)

Modifies the layer, adapting it to the provided devices

Declaration
public void Adapt(List<ArtemisDevice> devices)
Parameters
Type Name Description
List<ArtemisDevice> devices

The devices to adapt the layer to

Add(IAdaptionHint)

Adds an adaption hint to the adapter.

Declaration
public void Add(IAdaptionHint adaptionHint)
Parameters
Type Name Description
IAdaptionHint adaptionHint

The adaption hint to add.

Clear()

Removes all adaption hints from the adapter.

Declaration
public void Clear()

DetermineHints(IEnumerable<ArtemisDevice>)

Automatically determine hints for this layer

Declaration
public List<IAdaptionHint> DetermineHints(IEnumerable<ArtemisDevice> devices)
Parameters
Type Name Description
IEnumerable<ArtemisDevice> devices
Returns
Type Description
List<IAdaptionHint>

Load()

Loads the model from its associated entity

Declaration
public void Load()

Remove(IAdaptionHint)

Removes the first occurrence of a specific adaption hint from the adapter.

Declaration
public void Remove(IAdaptionHint adaptionHint)
Parameters
Type Name Description
IAdaptionHint adaptionHint

The adaption hint to remove.

Save()

Saves the model to its associated entity

Declaration
public void Save()

Events

AdapterHintAdded

Occurs whenever a new adapter hint is added to the adapter.

Declaration
public event EventHandler<LayerAdapterHintEventArgs>? AdapterHintAdded
Event Type
Type Description
EventHandler<LayerAdapterHintEventArgs>

AdapterHintRemoved

Occurs whenever an adapter hint is removed from the adapter.

Declaration
public event EventHandler<LayerAdapterHintEventArgs>? AdapterHintRemoved
Event Type
Type Description
EventHandler<LayerAdapterHintEventArgs>

Implements

IStorageModel