Class WaitEffector

This class is mostly meant as an example of an effector that does not complete instantly

Inheritance
object
AFunction
AEffector
WaitEffector
Inherited Members
Namespace: Xareus.Scenarios.Extra.Time
Assembly: Xareus.Scenarios.Extra.dll
Syntax
[Renamed("SEVEN.Time.WaitEffector", "SEVEN.Extra")]
public class WaitEffector : AEffector

Constructors

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

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

Fields

Time

minimum time before triggering (in units).

Declaration
[ConfigurationParameter("delay", "time before finishing the effector (in units). The time is a lower bound. Real time depends on the scenario update frequency.", Necessity.Required)]
protected double Time
Field Value
Type Description
double

Unit

time unit used (eg: second, minute)

Declaration
[ConfigurationParameter("unit", TimeUnit.SECOND, "time unit used (eg: second, minute). default : second", Necessity.Optional)]
protected TimeUnit Unit
Field Value
Type Description
TimeUnit

expectedDateTime

Declaration
protected DateTime expectedDateTime
Field Value
Type Description
DateTime

Properties

EffectorInitializationDateTime

Declaration
public DateTime EffectorInitializationDateTime { get; protected set; }
Property Value
Type Description
DateTime

Finished

Is the effector finished processing ?

Declaration
public override bool Finished { get; }
Property Value
Type Description
bool
Overrides

Methods

EffectorUpdate()

Applies a processing as soon as the event occurs.

Declaration
public override void EffectorUpdate()
Overrides