Class Event

Inheritance
object
Extendable
Identifiable
Event
DecisionEvent
Inherited Members
Namespace: Xareus.Scenarios
Assembly: Xareus.Scenarios.dll
Syntax
[Serializable]
public class Event : Identifiable

Constructors

Event(string, string)

Constructor

Declaration
public Event(string id, string label = "")
Parameters
Type Name Description
string id

The Id must be unique
string label

The label (optional)

Properties

ApplyingEffect

Is the event currently applying the effect ?

Declaration
public bool ApplyingEffect { get; }
Property Value
Type Description
bool

AssignmentEval

The assignment evaluation used in the event.

Declaration
public AAssignmentEval AssignmentEval { set; }
Property Value
Type Description
AAssignmentEval

AssignmentEvalParameters

Declaration
public Dictionary<string, Parameter> AssignmentEvalParameters { get; }
Property Value
Type Description
Dictionary<string, Parameter>

EffectApplied

Has the event finished applying the effect ?

Declaration
public bool EffectApplied { get; }
Property Value
Type Description
bool

EffectorUpdate

The effector update used in the event. Null if the event is not currently applying an effect Setting the effector while is event is applying an effect will NOT apply the new effect Note : this will only act on the first effector in the list

Declaration
public AEffector EffectorUpdate { get; }
Property Value
Type Description
AEffector

Effectors

The effectors used in the event. Empty if the event is not currently applying an effect

Declaration
public IEnumerable<AEffector> Effectors { get; }
Property Value
Type Description
IEnumerable<AEffector>

IsChecking

Is the event currently checking ?

Declaration
public bool IsChecking { get; }
Property Value
Type Description
bool

SensorCheck

The sensor check used in the event. Null if the event is not currently checking Setting the sensor while the event is checking will stop the current sensor and start the new one Note : this will only act on the first sensor in the list

Declaration
public ASensor SensorCheck { get; }
Property Value
Type Description
ASensor

Sensors

The sensors used in the event. Empty if the event is not currently checking Setting the sensors while the event is checking will stop the current sensors and start the new ones

Declaration
public IEnumerable<ASensor> Sensors { get; }
Property Value
Type Description
IEnumerable<ASensor>

assignment

Declaration
public virtual List<Reference> assignment { get; set; }
Property Value
Type Description
List<Reference>

assignmentEval

Declaration
public virtual Function assignmentEval { get; set; }
Property Value
Type Description
Function

effectorUpdate

Declaration
public virtual List<Function> effectorUpdate { get; set; }
Property Value
Type Description
List<Function>

sensorCheck

Declaration
public virtual List<Function> sensorCheck { get; set; }
Property Value
Type Description
List<Function>

Methods

AddEffector(AEffector, int)

Add an effector to the transition event

Declaration
public void AddEffector(AEffector effector, int index = -1)
Parameters
Type Name Description
AEffector effector
int index

index to add the sensor to. default or -1 adds the sensor at the end of the list
Exceptions
Type Condition
ArgumentNullException

AddEffector(Function, int)

Add an effector to the transition event

Declaration
public void AddEffector(Function function, int index = -1)
Parameters
Type Name Description
Function function
int index

index to add the sensor to. default or -1 adds the sensor at the end of the list
Exceptions
Type Condition
ArgumentNullException

AddSensor(Function, int)

Add a sensor to the transition event

Declaration
public void AddSensor(Function function, int index = -1)
Parameters
Type Name Description
Function function
int index

index to add the sensor to. default or -1 adds the sensor at the end of the list
Exceptions
Type Condition
ArgumentNullException

AddSensor(ASensor, int)

Add a sensor to the transition event

Declaration
public void AddSensor(ASensor sensor, int index = -1)
Parameters
Type Name Description
ASensor sensor
int index

index to add the sensor to. default or -1 adds the sensor at the end of the list
Exceptions
Type Condition
ArgumentNullException

GetAllFunctions()

Get all the functions used in this event

Declaration
public IEnumerable<Function> GetAllFunctions()
Returns
Type Description
IEnumerable<Function>

The functions used in the event

GetAllInstantiatedFunctions()

Get all the instantiated functions used in this event

Declaration
public IEnumerable<AFunction> GetAllInstantiatedFunctions()
Returns
Type Description
IEnumerable<AFunction>

The instantiated functions used in the event

RemoveEffector(int)

Remove an effector from the transition event

Declaration
public void RemoveEffector(int index)
Parameters
Type Name Description
int index

RemoveSensor(int)

Remove a sensor from the transition event

Declaration
public void RemoveSensor(int index)
Parameters
Type Name Description
int index

SetAssignmentEval(AAssignmentEval)

Set the assignment eval function to use from an existing instance

Declaration
[Obsolete("Use AssignmentEval property instead")]
public void SetAssignmentEval(AAssignmentEval value)
Parameters
Type Name Description
AAssignmentEval value

Extension Methods