aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/SideChains/RealTimeGraphX/GraphInputOutputComponentBase.cs
blob: fb58c0e0a63b95d6f6f53f918bb015ccd812eeaa (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
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keywor
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using RealTimeGraphX.EventArguments;

namespace RealTimeGraphX
{
    /// <summary>
    /// Represents a <see cref="IGraphOutputComponent{TOut}"/> and <see cref="IGraphInputComponent{TIn}"/> base class.
    /// </summary>
    /// <typeparam name="TIn">The type of the in.</typeparam>
    /// <typeparam name="TOut">The type of the out.</typeparam>
    /// <seealso cref="RealTimeGraphX.GraphObject" />
    /// <seealso cref="RealTimeGraphX.IGraphInputComponent{TIn}" />
    /// <seealso cref="RealTimeGraphX.IGraphOutputComponent{TOut}" />
    public abstract class GraphInputOutputComponentBase<TIn, TOut> : GraphObject, IGraphInputComponent<TIn>, IGraphOutputComponent<TOut> where TIn : IGraphComponent where TOut : IGraphComponent
    {
        /// <summary>
        /// Occurs when the <see cref="P:RealTimeGraphX.IGraphInputComponent`1.Input" /> property has changed.
        /// </summary>
        public event EventHandler<InputChangedEventArgs<TIn>> InputChanged;

        /// <summary>
        /// Occurs when the <see cref="P:RealTimeGraphX.IGraphOutputComponent`1.Output" /> property has changed.
        /// </summary>
        public event EventHandler<OutputChangedEventArgs<TOut>> OutputChanged;

        private TIn _input;
        /// <summary>
        /// Gets the connected input <see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        public TIn Input
        {
            get { return _input; }
            protected set
            {
                _input = value;
                RaisePropertyChangedAuto();
                OnInputChanged(_input);
            }
        }

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

        /// <summary>
        /// Raises the <see cref="InputChanged"/> event.
        /// </summary>
        /// <param name="input">The input.</param>
        protected virtual void OnInputChanged(TIn input)
        {
            InputChanged?.Invoke(this, new InputChangedEventArgs<TIn>(input));
        }

        /// <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 the specified component output to this component input.
        /// </summary>
        /// <param name="component">The component.</param>
        /// <param name="fromInput">Specifies whether this call was made from a <see cref="TIn" /> component.</param>
        public abstract void ConnectInput(TIn component, bool fromInput = false);

        /// <summary>
        /// Disconnects this component input from the current connected <see cref="P:RealTimeGraphX.IGraphInputComponent`1.Input" /><see cref="T:RealTimeGraphX.IGraphComponent" />.
        /// </summary>
        /// <param name="fromInput">Specifies whether this call was made from a <see cref="TIn" /> component.</param>
        public abstract void DisconnectInput(bool fromInput = false);

        /// <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);
    }
}