ControlParameterNode.cs

using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using System.Xml;
using TAG.Simulator.ObjectModel.Actors;
using TAG.Simulator.ObjectModel.Events;
using TAG.Simulator.ObjectModel.Values;
using Waher.Content.Xml;
using Waher.Script;
using Waher.Things.ControlParameters;
 
namespace TAG.Simulator.XMPP.IoT.Extensions.ControlParameters
{
    public abstract class ControlParameterNode : NodeReference, IValueRecipient, IEventPreparation
    {
        private IValue value = null;
        private string name;
        private string page;
        private string label;
        private string description;
        private string variable;
        private string actor;
        private string setEventId;
        private IEvent setEvent;
 
        public ControlParameterNode(ISimulationNode Parent, Model Model)
            : base(Parent, Model)
        {
        }
 
        public IValue Value => this.value;
 
        public string Name => this.name;
 
        public string Page => this.page;
 
        public string Label => this.label;
 
        public string Description => this.description;
 
        public string Variable => this.variable;
 
        public string Actor => this.actor;
 
        public IEvent SetEvent => this.setEvent;
 
        public string SetEventId => this.setEventId;
 
        public override Task FromXml(XmlElement Definition)
        {
            this.name = XML.Attribute(Definition, "name");
            this.page = XML.Attribute(Definition, "page");
            this.label = XML.Attribute(Definition, "label");
            this.description = XML.Attribute(Definition, "description");
            this.variable = XML.Attribute(Definition, "variable");
            this.actor = XML.Attribute(Definition, "actor");
            this.setEventId = XML.Attribute(Definition, "setEvent");
 
            return base.FromXml(Definition);
        }
 
        public void Register(IValue Value)
        {
            if (this.value is null)
                this.value = Value;
            else
                throw new Exception("Field node already has a value defined.");
        }
 
        public override Task Start()
        {
            if (!this.Model.TryGetEvent(this.setEventId, out this.setEvent))
                throw new Exception("Event not found: " + this.setEventId);
 
            this.setEvent.Register(this);
 
            return base.Start();
        }
 
        public abstract void AddParameters(List<ControlParameter> Parameters, IActor Actor);
 
        public Task Prepare(Variables Variables, List<KeyValuePair<string, object>> Tags)
        {
            return Task.CompletedTask;  // Do nothing.
        }
 
        public void Release(Variables Variables)
        {
            // Do nothing.
        }
 
        public void ExportPlantUml(StreamWriter Output, string Name, int Index)
        {
            Output.Write("actor \"");
            Output.Write(this.actor);
            Output.Write("\" as A");
            Output.Write(" <<");
            Output.Write(this.actor);
            Output.WriteLine(">>");
            Output.WriteLine("note right of A : Triggered when external\\ncontrol client sets parameter");
            Output.Write("A --> UC1 : ");
            Output.WriteLine(this.name);
        }
    }
}