Class ExternalScenario

An external scenario is a special kind of complexe sequence created from a full scenario file.

Inheritance
object
Extendable
Identifiable
ASequence
ComplexSequence
ProxySequence
ExternalScenario
Inherited Members
Namespace: Xareus.Scenarios
Assembly: Xareus.Scenarios.dll
Syntax
[Serializable]
public class ExternalScenario : ProxySequence

Constructors

ExternalScenario(string, string)

Constructor

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

The Id must be unique
string label

The label (optional)

Properties

FileAbsolutePath

Get the file path abstolute path using the root scenario file as reference

Declaration
public string FileAbsolutePath { get; }
Property Value
Type Description
string

FileRelativeToParent

Get the file path relative to the parent scenario

Declaration
public string FileRelativeToParent { get; }
Property Value
Type Description
string

FileRelativeToRoot

Get the file path relative to the root scenario

Declaration
public string FileRelativeToRoot { get; }
Property Value
Type Description
string

Functions

Declaration
public override IEnumerable<Function> Functions { get; }
Property Value
Type Description
IEnumerable<Function>
Overrides

Loaded

Is the scenario loaded ?

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

LocalFunctions

Declaration
public override IEnumerable<Function> LocalFunctions { get; }
Property Value
Type Description
IEnumerable<Function>
Overrides

Scenario

The scenario (null if not loaded)

Declaration
public Scenario Scenario { get; set; }
Property Value
Type Description
Scenario

ScenarioFile

The scenario file path (when setting: relative to parent scenario or absolute, when getting: relative to parent scenario only)

Declaration
public string ScenarioFile { get; set; }
Property Value
Type Description
string

SubSequences

Declaration
public override IEnumerable<ASequence> SubSequences { get; }
Property Value
Type Description
IEnumerable<ASequence>
Overrides

file

Declaration
public virtual string file { get; set; }
Property Value
Type Description
string

Methods

AddToken(IContext)

Declaration
public override void AddToken(IContext token)
Parameters
Type Name Description
IContext token
Overrides

Configure()

Apply the configuration. During this step, the configuration context of the parent sequence is used to create the configuration context of the current sequence The Configuration context used by the function comes from the parent sequence of the current sequence The Configuration context returned by the function is used by the current sequence

Declaration
public override void Configure()
Overrides

GetToken()

Declaration
public override IContext GetToken()
Returns
Type Description
IContext
Overrides

HasReachedFinalState()

Declaration
public override bool HasReachedFinalState()
Returns
Type Description
bool
Overrides

HasToken()

Declaration
public override bool HasToken()
Returns
Type Description
bool
Overrides

ImportConfigurationFromScenario()

Import (i.e. copy) the configuration function from the scenario into this external scenario node

Declaration
public void ImportConfigurationFromScenario()

RemoveToken()

Declaration
public override void RemoveToken()
Overrides

Extension Methods