Class AEffector

Inheritance

object

AFunction

AEffector

NumberEffector

RandomNumberEffector

BooleanEffector

SelectFromListEffector

WaitEffector

ActivateTriggerEffector

AddTokenToSequencesEffector

LoadScenarioStateEffector

LoadScenarioStateFromFileEffector

LoadSequenceStateEffector

LoadSequenceStateFromFileEffector

RemoveTokensFromSequencesEffector

SaveScenarioStateEffector

SaveScenarioStateInFileEffector

SaveSequenceStateEffector

SaveSequenceStateInFileEffector

SetValueInContextEffector

Inherited Members

AFunction.Parameters

AFunction.Contexts

AFunction.Reset()

AFunction.UpdateContexts(ContextHolder)

AFunction.FillParameters()

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>, ContextHolder)

Constructor for an effector

Declaration

protected AEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)

Parameters

Type	Name	Description
Event	event	The event holding the effector
Dictionary<string, Parameter>	parameters	The parameters of the effector
ContextHolder	contexts	The contexts

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

Constructor for an effector

Declaration

[Obsolete("Use AEffector(Event, Dictionary<string, Parameter>, ContextHolder) instead.")]
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

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

eventContext

Declaration

[Obsolete("Use Contexts.EventContext instead.")]
protected IContext eventContext { get; }

Property Value

Type	Description
IContext

externalContext

Declaration

[Obsolete("Use Contexts.ExternalContext instead.")]
protected IContext externalContext { get; }

Property Value

Type	Description
IContext

scenarioContext

Declaration

[Obsolete("Use Contexts.ScenarioContext instead.")]
protected IContext scenarioContext { get; }

Property Value

Type	Description
IContext

sequenceContext

Declaration

[Obsolete("Use Contexts.SequenceContext instead.")]
protected IContext sequenceContext { get; }

Property Value

Type	Description
IContext

Methods

EffectorUpdate()

Applies a processing as soon as the event occurs.

Declaration

public abstract void EffectorUpdate()