Class RelationSensor

Checks for the execution of a relation (i.e. realization) which involves other optional objects. The expected parameters follow. relation expects the name of the relation. object expects the name of an object (0 to multiple occurences allowed).

Inheritance
object
AFunction
ASensor
RelationSensor
Inherited Members
Namespace: Xareus.Scenarios.Relations
Assembly: Xareus.Scenarios.Relations.dll
Syntax
[Renamed("RelationSensor", "SEVEN.FIVE")]
[Renamed("SEVEN.FIVE.RelationSensor", "SEVEN.FIVE")]
[FunctionDescription("The resulting event context contains the realization at root and the relanion name at 'relation'")]
public class RelationSensor : ASensor

Constructors

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

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

Fields

REALIZATION

Declaration
public static readonly string REALIZATION
Field Value
Type Description
string

RELATION_ENTRY

Declaration
public static readonly string RELATION_ENTRY
Field Value
Type Description
string

Properties

Objects

Declaration
[ConfigurationParameter("object", "The Five Objects that must appear in the relation", Necessity.Optional)]
public HashSet<IObject> Objects { get; protected set; }
Property Value
Type Description
HashSet<IObject>

Relation

Declaration
[ConfigurationParameter("relation", Necessity.Required)]
public IRelation Relation { get; protected set; }
Property Value
Type Description
IRelation

Methods

Reset()

Declaration
public override void Reset()
Overrides

SensorCheck()

Declaration
public override ASensor.Result SensorCheck()
Returns
Type Description
ASensor.Result
Overrides