MewtocolNet/MewtocolNet/Mewtocol/RegisterAttributes/RegisterAttribute.cs

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

namespace MewtocolNet.RegisterAttributes {

    /// <summary>
    /// The size of the bitwise register
    /// </summary>
    public enum BitCount {
        /// <summary>
        /// 16 bit
        /// </summary>
        B16,
        /// <summary>
        /// 32 bit
        /// </summary>
        B32
    }

    /// <summary>
    /// Defines the behavior of a register property
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class RegisterAttribute : Attribute {

        internal int MemoryArea;
        internal int StringLength;
        internal RegisterType RegisterType;
        internal SpecialAddress SpecialAddress = SpecialAddress.None;
        internal BitCount BitCount;
        internal int AssignedBitIndex = -1;


        /// <summary>
        /// Attribute for string type or numeric registers 
        /// </summary>
        /// <param name="memoryArea">The area in the plcs memory</param>
        /// <param name="stringLength">The max string length in the plc</param>
        public RegisterAttribute (int memoryArea, int stringLength = 1) {

            MemoryArea = memoryArea;
            StringLength = stringLength;   

        }

        /// <summary>
        /// Attribute for boolean registers
        /// </summary>
        /// <param name="memoryArea">The area in the plcs memory</param>
        /// <param name="type">The type of boolean register</param>
        public RegisterAttribute (int memoryArea, RegisterType type) {

            if (type.ToString().StartsWith("DT"))
                throw new NotSupportedException("DT types are not supported for attribute register setups because the number type is casted automatically");

            MemoryArea = memoryArea;
            RegisterType = type;
            SpecialAddress = SpecialAddress.None;

        }

        /// <summary>
        /// Attribute for boolean registers
        /// </summary>
        /// <param name="spAdress">The special area in the plcs memory</param>
        /// <param name="type">The type of boolean register</param>
        public RegisterAttribute (RegisterType type, SpecialAddress spAdress) {

            if (type.ToString().StartsWith("DT"))
                throw new NotSupportedException("DT types are not supported for attribute register setups because the number type is casted automatically");

            RegisterType = type;
            SpecialAddress = spAdress;

        }

        /// <summary>
        /// Attribute to read numeric registers as bitwise
        /// </summary>
        /// <param name="memoryArea">The area in the plcs memory</param>
        /// <param name="bitcount">The number of bits to parse</param>
        public RegisterAttribute (int memoryArea, BitCount bitcount) {

            MemoryArea = memoryArea;
            StringLength = 0;
            BitCount = bitcount;

        }

        /// <summary>
        /// Attribute to read numeric registers as bitwise
        /// </summary>
        /// <param name="memoryArea">The area in the plcs memory</param>
        /// <param name="bitcount">The number of bits to parse</param>
        /// <param name="assignBit">The index of the bit that gets linked to the bool</param>
        public RegisterAttribute (int memoryArea, uint assignBit, BitCount bitcount) {

            if(assignBit > 15 && bitcount == BitCount.B16) {
                throw new NotSupportedException("The assignBit parameter cannot be greater than 15 in a 16 bit var");
            }

            if (assignBit > 31 && bitcount == BitCount.B32) {
                throw new NotSupportedException("The assignBit parameter cannot be greater than 31 in a 32 bit var");
            }

            MemoryArea = memoryArea;
            StringLength = 0;
            BitCount = bitcount;
            AssignedBitIndex = (int)assignBit;

        }

    }

}