Class TimeSensor
Trigger a transition after a fixed time.
The time is a lower bound. Real time depends on the scenario update frequency.
The expected parameters follow.
minimum
minimum time before triggering (in units).
Assembly: Xareus.Scenarios.Extra.dll
Syntax
[Renamed("SEVEN.Time.TimeSensor", "SEVEN.Extra", typeof(TimeParametersConverter))]
[Renamed("TimeSensor", "SEVEN.Extra", typeof(TimeParametersConverter))]
[Renamed("SEVEN.Time.TimeSensor", "SEVEN.Extra")]
[FunctionDescription("Note : Time precision depends on the refresh rate of the scenario engine")]
public class TimeSensor : ASensor
Constructors
TimeSensor(Event, Dictionary<string, Parameter>, IContext, IContext, IContext)
Declaration
public TimeSensor(Event @event, Dictionary<string, Parameter> parameters, IContext externalContext, IContext scenarioContext, IContext sequenceContext)
Parameters
Fields
KEY_TIME
Declaration
public static readonly string KEY_TIME
Field Value
Unit
time unit used (eg: second, minute)
Declaration
[ConfigurationParameter("unit", TimeUnit.SECOND, "time unit used (eg: second, minute, hour). default : second", Necessity.Optional)]
protected TimeUnit Unit
Field Value
eventContext
Declaration
protected SimpleDictionary eventContext
Field Value
expectedDateTime
When the sensor should trigger
Declaration
protected DateTime expectedDateTime
Field Value
Type |
Description |
DateTime |
|
time
minimum time before triggering (in units).
Declaration
[ConfigurationParameter("minimum", "minimum time before triggering. The time is a lower bound. Real time depends on the scenario update frequency.", Necessity.Required)]
protected double time
Field Value
Properties
SensorInitializationDateTime
Declaration
public DateTime SensorInitializationDateTime { get; protected set; }
Property Value
Type |
Description |
DateTime |
|
Methods
Reset()
Declaration
public override void Reset()
Overrides
SensorCheck()
Declaration
public override ASensor.Result SensorCheck()
Returns
Overrides