Node.cs

// ------------------------------------------
// <copyright file="Node.cs" company="Pedro Sequeira">
// 
//     Copyright (c) 2018 Pedro Sequeira
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to the following conditions:
//  
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
// Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
// OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// 
// </copyright>
// <summary>
//    Project: Comuna.Graphviz
//    Last updated: 06/14/2018
//    Author: Pedro Sequeira
//    E-mail: pedrodbs@gmail.com
// </summary>
// ------------------------------------------

using QuickGraph.Graphviz.Dot;

namespace Comuna.Graphviz
{
    /// <summary>
    ///     Represents a node structure used to save a node of a <see cref="Network" /> to a Graphviz dot file.
    /// </summary>
    public class Node
    {
        #region Constructors

        /// <summary>
        ///     Creates a new <see cref="Node" /> with the given ID.
        /// </summary>
        /// <param name="id">The id of the node.</param>
        /// <param name="community">The id of the community of this node</param>
        public Node(uint id, uint community = 0)
        {
            this.IdNum = id;
            this.Community = community;
        }

        #endregion

        #region Properties & Indexers

        /// <summary>
        ///     Gets or sets the node's color.
        /// </summary>
        public GraphvizColor Color { get; set; }

        /// <summary>
        ///     Gets or sets the ID of the community of this node.
        /// </summary>
        public uint Community { get; }

        /// <summary>
        ///     Gets or sets the ID of this node.
        /// </summary>
        public uint IdNum { get; }

        /// <summary>
        ///     Gets or sets a value indicating whether to show the node's label.
        /// </summary>
        public bool ShowLabel { get; set; }

        #endregion

        #region Public Methods

        /// <inheritdoc />
        public override bool Equals(object obj)
        {
            return !(obj is null) &&
                   (ReferenceEquals(this, obj) || obj.GetType() == this.GetType() && this.Equals((Node) obj));
        }

        /// <inheritdoc />
        public override int GetHashCode() => (int) this.IdNum;

        #endregion

        #region Public Methods

        /// <summary>
        ///     Tests whether the two nodes are equal.
        /// </summary>
        /// <param name="left">The first node.</param>
        /// <param name="right">The second node.</param>
        /// <returns>A <see cref="bool" /> indicating whether the two nodes are equal.</returns>
        public static bool operator ==(Node left, Node right) => Equals(left, right);

        /// <summary>
        ///     Tests whether the two nodes are different (not equal).
        /// </summary>
        /// <param name="left">The first node.</param>
        /// <param name="right">The second node.</param>
        /// <returns>A <see cref="bool" /> indicating whether the two nodes are different.</returns>
        public static bool operator !=(Node left, Node right) => !Equals(left, right);

        #endregion

        #region Private & Protected Methods

        private bool Equals(Node other) => this.IdNum == other.IdNum;

        #endregion
    }
}