Software/Visual_Studio/SideChains/RealTimeGraphX/IGraphOutputComponent.cs


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

using RealTimeGraphX.EventArguments;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace RealTimeGraphX
{
    /// <summary>
    /// Represents a graph component which passes data to some other type of component.
    /// </summary>
    /// <typeparam name="TOut">The type of the out.</typeparam>
    /// <seealso cref="RealTimeGraphX.IGraphComponent" />
    public interface IGraphOutputComponent<TOut> : IGraphComponent where TOut : IGraphComponent
    {
        /// <summary>
        /// Occurs when the <see cref="Output"/> property has changed.
        /// </summary>
        event EventHandler<OutputChangedEventArgs<TOut>> OutputChanged;

        /// <summary>
        /// Gets the connected output <see cref="IGraphComponent"/>.
        /// </summary>
        TOut Output { get; }

        /// <summary>
        /// Connects this component to another <see cref="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>
        void ConnectOutput(TOut output, bool fromOutput = false);

        /// <summary>
        /// Disconnects this component from the connected <see cref="Output"/> <see cref="IGraphComponent"/>.
        /// </summary>
        /// <param name="fromOutput">Specifies whether this call was made from a <see cref="TOut"/> component.</param>
        void DisconnectOutput(bool fromOutput = false);
    }
}