Class AEffector

Inheritance

object

AFunction

AEffector

NumberEffector

RandomNumberEffector

BooleanEffector

SelectFromListEffector

WaitEffector

AddTokenToSequencesEffector

LoadScenarioStateEffector

LoadScenarioStateFromFileEffector

LoadSequenceStateEffector

LoadSequenceStateFromFileEffector

RemoveTokensFromSequencesEffector

SaveScenarioStateEffector

SaveScenarioStateInFileEffector

SaveSequenceStateEffector

SaveSequenceStateInFileEffector

SetValueInContextEffector

Inherited Members

AFunction.Parameters

AFunction.Reset()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Effector

Assembly: Xareus.Scenarios.dll

Syntax

public abstract class AEffector : AFunction

Constructors

AEffector()

Base constructor for effector

Declaration

protected AEffector()

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

Constructor for an effector

Declaration

protected AEffector(Event @event, Dictionary<string, Parameter> parameters, IContext externalContext, IContext scenarioContext, IContext sequenceContext, IContext eventContext)

Parameters

Type	Name	Description
Event	event	The event holding the effector
Dictionary<string, Parameter>	parameters	The parameters of the effector
IContext	externalContext	The external context
IContext	scenarioContext	The scenario context
IContext	sequenceContext	The token
IContext	eventContext	The result of the sensor that triggered this event

Fields

eventContext

The context in which the event occurred

Declaration

protected IContext eventContext

Field Value

Type	Description
IContext

externalContext

The external context

Declaration

protected IContext externalContext

Field Value

Type	Description
IContext

scenarioContext

The scenario context

Declaration

protected IContext scenarioContext

Field Value

Type	Description
IContext

sequenceContext

The context conveyed by the sequence

Declaration

protected IContext sequenceContext

Field Value

Type	Description
IContext

Properties

Event

The Event holding the effector

Declaration

public Event Event { get; }

Property Value

Type	Description
Event

Finished

Is the effector finished processing ?

Declaration

public virtual bool Finished { get; }

Property Value

Type	Description
bool

Methods

EffectorUpdate()

Applies a processing as soon as the event occurs.

Declaration

public abstract void EffectorUpdate()

FillParameters()

Fill the parameters of the effector. Should only be called when creating the effector as we run it right after

Declaration

public virtual void FillParameters()

SetContexts(IContext, IContext)

Sets/Updates the contexts of the effector and update the parameters

Declaration

public void SetContexts(IContext sequenceContext, IContext eventContext)

Parameters

Type	Name	Description
IContext	sequenceContext
IContext	eventContext