Class EventSensor

A Sensor that can be activated by calling its Activate Method

Inheritance
object
AFunction
ASensor
EventSensor
TypeTest.OverrideClass
Inherited Members
Namespace: Xareus.Scenarios.Extra
Assembly: Xareus.Scenarios.Extra.dll
Syntax
[Renamed("EventSensor", "SEVEN.Extra")]
[Renamed("SEVEN.Extra.EventSensor", "SEVEN.Extra")]
public class EventSensor : ASensor

Constructors

EventSensor(string)

Declaration
public EventSensor(string label = null)
Parameters
Type Name Description
string label

EventSensor(Event, Dictionary<string, Parameter>, IContext, IContext, IContext)

Constructor for a Sensor

Declaration
public EventSensor(Event @event, Dictionary<string, Parameter> parameters, IContext externalContext, IContext scenarioContext, IContext sequenceContext)
Parameters
Type Name Description
Event event

The event that holds the sensor
Dictionary<string, Parameter> parameters

The parameters of the sensor
IContext externalContext

The external context
IContext scenarioContext

The scenario context
IContext sequenceContext

The merged token of the upstream sequences

Properties

Label

The label of the sensor, used for debugging puposes

Declaration
[ConfigurationParameter("label", Necessity.Optional)]
public string Label { get; }
Property Value
Type Description
string

Methods

Activate()

Call this method to activate the sensor

Declaration
public void Activate()

Deactivate()

Call this method to deactivate the sensor

Declaration
public void Deactivate()

Reset()

Initilizes the function. This method can be called when a function is created and when it is reset to be used again

Declaration
public override void Reset()
Overrides

SensorCheck()

Checks whether an event was triggered.

Declaration
public override ASensor.Result SensorCheck()
Returns
Type Description
ASensor.Result

ASensor.Result
Overrides