aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/SideChains/RealTimeGraphX/GraphOutputComponentBase.cs
blob: 2d0cae959225bef4b6b8179eab1b6e321a93628b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using RealTimeGraphX.EventArguments;

namespace RealTimeGraphX
{
    /// <summary>
    /// Represents an <see cref="IGraphOutputComponent{TOut}"/> base class.
    /// </summary>
    /// <typeparam name="TOut">The type of the out.</typeparam>
    /// <seealso cref="RealTimeGraphX.GraphObject" />
    /// <seealso cref="RealTimeGraphX.IGraphOutputComponent{TOut}" />
    public abstract class GraphOutputComponentBase<TOut> : GraphObject, IGraphOutputComponent<TOut> where TOut : IGraphComponent
    {
        /// <summary>
        /// Occurs when the <see cref="P:RealTimeGraphX.IGraphOutputComponent`1.Output" /> property has changed.
        /// </summary>
        public event EventHandler<OutputChangedEventArgs<TOut>> OutputChanged;

        private TOut _output;
        /// <summary>
        /// Gets the connected output <see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        public TOut Output
        {
            get { return _output; }
            set
            {
                _output = value;
                RaisePropertyChangedAuto();
                OnOutputChanged(_output);
            }
        }

        /// <summary>
        /// Raises the <see cref="OutputChanged"/> event.
        /// </summary>
        /// <param name="output">The output.</param>
        protected virtual void OnOutputChanged(TOut output)
        {
            OutputChanged?.Invoke(this, new OutputChangedEventArgs<TOut>(output));
        }

        /// <summary>
        /// Connects this component to another <see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        /// <param name="output">The output component.</param>
        /// <param name="fromOutput">Specifies whether this call was made from a <see cref="TOut" /> component.</param>
        public abstract void ConnectOutput(TOut output, bool fromOutput = false);

        /// <summary>
        /// Disconnects this component from the connected <see cref="P:RealTimeGraphX.IGraphOutputComponent`1.Output" /><see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        /// <param name="fromOutput">Specifies whether this call was made from a <see cref="TOut" /> component.</param>
        public abstract void DisconnectOutput(bool fromOutput = false);
    }
}