RevitSdkSamples/SDK/Samples/PathReinforcement/CS/PathReinProperties.cs

//
// (C) Copyright 2003-2019 by Autodesk, Inc.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. AUTODESK, INC.
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
//
// Use, duplication, or disclosure by the U.S. Government is subject to
// restrictions set forth in FAR 52.227-19 (Commercial Computer
// Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
// (Rights in Technical Data and Computer Software), as applicable.
//


using System;
using System.Collections.Generic;
using System.Text;
using System.Reflection;
using System.ComponentModel;

using Autodesk.Revit;
using Autodesk.Revit.DB;

namespace Revit.SDK.Samples.PathReinforcement.CS
{
    /// <summary>
    /// path reinforcement layout rules parameters.
    /// </summary>
    public enum LayoutRule
    {
        /// <summary>
        /// fixed number layout rule.
        /// </summary>
        Fixed_Number = 2,

        /// <summary>
        /// maximum spacing layout rule.
        /// </summary>
        Maximum_Spacing = 3
    };

    /// <summary>
    /// path reinforcement face parameters.
    /// </summary>
    public enum Face
    {
        /// <summary>
        /// floor top or wall exterior.
        /// </summary>
        Top = 0,

        /// <summary>
        /// floor bottom or wall interior.
        /// </summary>
        Bottom
    };

    /// <summary>
    /// This class used as PropertyGrid.SelectedObject.
    /// It stores parameters of path reinforcement.
    /// </summary>
    [DefaultPropertyAttribute("NumberOfBars")]
    public class PathReinProperties
    {
        /// <summary>
        /// cache path reinforcement object.
        /// </summary>
        protected Autodesk.Revit.DB.Structure.PathReinforcement m_pathRein;

        /// <summary>
        /// layout rule 
        /// </summary>
        private LayoutRule m_layoutRule;

        /// <summary>
        /// face parameter
        /// </summary>
        private Face m_face;

        /// <summary>
        /// number of bars
        /// </summary>
        private int m_numberOfBars;

        /// <summary>
        /// bar spacing
        /// </summary>
        private String m_barSpacing;

        /// <summary>
        /// primary bar type
        /// </summary>
        private Autodesk.Revit.DB.ElementId m_primaryBarType;

        /// <summary>
        /// primary bar length
        /// </summary>
        private String m_primaryBarLength;

        #region EventHandler for updating selected object of PropertyGrid
        /// <summary>
        /// update selected object of Property grid after enable / disable some properties.
        /// </summary>
        public delegate void UpdateSelectObjEventHandler();

        /// <summary>
        /// my event object of updating event
        /// </summary>
        public event UpdateSelectObjEventHandler UpdateSelectObjEvent;
        #endregion

        /// <summary>
        /// constructor of class
        /// </summary>
        /// <param name="pathRein"></param>
        public PathReinProperties(Autodesk.Revit.DB.Structure.PathReinforcement pathRein)
        {
            m_pathRein = pathRein;
            m_layoutRule = (LayoutRule)GetParameter("Layout Rule").AsInteger();
            m_face = (Face)GetParameter("Face").AsInteger();
            m_numberOfBars = m_pathRein.get_Parameter(
                    BuiltInParameter.PATH_REIN_NUMBER_OF_BARS).AsInteger();
            m_barSpacing = m_pathRein.get_Parameter(
                    BuiltInParameter.PATH_REIN_SPACING).AsValueString();
            m_primaryBarLength = m_pathRein.get_Parameter(
                    BuiltInParameter.PATH_REIN_LENGTH_1).AsValueString();
            m_primaryBarType = GetParameter("Primary Bar - Type").AsElementId();
        }

        /// <summary>
        /// update the parameters of path reinforcement.
        /// </summary>
        public void Update()
        {
            try
            {
                GetParameter("Layout Rule").Set((int)m_layoutRule);
                GetParameter("Face").Set((int)m_face);
                GetParameter("Primary Bar - Type").Set(m_primaryBarType);
                m_pathRein.get_Parameter(
                    BuiltInParameter.PATH_REIN_LENGTH_1).SetValueString(m_primaryBarLength);                

                // if layout rule is maximum spacing, number of bar will be read only.
                // In order to update previously modified number of bar, we should change the layout rule
                // to fixed number, and then set the layout rule back.
                if(m_layoutRule == LayoutRule.Maximum_Spacing)
                {
                    m_pathRein.get_Parameter(
                                    BuiltInParameter.PATH_REIN_SPACING).SetValueString(m_barSpacing);
                    GetParameter("Layout Rule").Set((int)LayoutRule.Fixed_Number);
                    m_pathRein.get_Parameter(
                            BuiltInParameter.PATH_REIN_NUMBER_OF_BARS).Set(m_numberOfBars);
                    GetParameter("Layout Rule").Set((int)m_layoutRule);                    
                }
                // if layout rule is fixed number, bar spacing will be read only.
                // In order to update previously modified bar spacing, we should change the layout rule 
                // to maximum spacing, and then set the layout rule back.
                else if (m_layoutRule == LayoutRule.Fixed_Number)
                {
                    m_pathRein.get_Parameter(
                            BuiltInParameter.PATH_REIN_NUMBER_OF_BARS).Set(m_numberOfBars);
                    GetParameter("Layout Rule").Set((int)LayoutRule.Maximum_Spacing);
                    m_pathRein.get_Parameter(
                            BuiltInParameter.PATH_REIN_SPACING).SetValueString(m_barSpacing);
                    GetParameter("Layout Rule").Set((int)m_layoutRule);
                }
            }
            catch (Exception e)
            {
                Autodesk.Revit.UI.TaskDialog.Show("Exception", e.ToString());
            }
        }

        /// <summary>
        /// Bar numbers of path reinforcement,read only property.
        /// the property is read-only by default
        /// </summary>
        [Category("Layers"), DisplayName("Number of Bars"), ReadOnly(true)]
        public int NumberOfBars
        {
            get
            {
                return m_numberOfBars;
            }
            set
            {
                m_numberOfBars = value;
            }
        }

        /// <summary>
        /// Layout rule of path reinforcement,get/set property.
        /// </summary>
        [Category("Construction"), DisplayName("Layout Rule"), ReadOnly(false)]
        public LayoutRule LayoutRule
        {
            get
            {
                return m_layoutRule;
            }
            set
            {
                if(m_layoutRule == value)
                {
                    return;
                }
                m_layoutRule = value;

                // set BarSpacing and NumberOfBars readonly dynamically when:
                // When set LayoutRule to "Fixed Number", BarSpacing should be read only
                // When set to "Maximum Spacing", Number Of Bars should be read only
                if (m_layoutRule == LayoutRule.Fixed_Number)
                {
                    SetPropertyReadOnly("BarSpacing", true);
                    SetPropertyReadOnly("NumberOfBars", false);
                }
                else if (m_layoutRule == LayoutRule.Maximum_Spacing)
                {
                    SetPropertyReadOnly("BarSpacing", false);
                    SetPropertyReadOnly("NumberOfBars", true);
                }

                // update the selected object is necessary
                if (null != UpdateSelectObjEvent)
                {
                    UpdateSelectObjEvent();
                }
            }
        }

        /// <summary>
        /// Bar spacing of path reinforcement,get/set property.
        /// </summary>
        [Category("Layers"), DisplayName("Bar Spacing"), ReadOnly(false)]
        public String BarSpacing
        {
            get
            {
                return m_barSpacing;
            }
            set
            {
                if (!ValidateInch(value))
                {
                    throw new Exception("Invalid value.");
                }
                m_barSpacing = value;
            }
        }

        /// <summary>
        /// Primary bar type of path reinforcement,get/set property.
        /// </summary>
        [Category("Layers"), TypeConverter(typeof(BartypeConverter)), DisplayName("Primary Bar - Type")]
        public Autodesk.Revit.DB.ElementId PrimaryBarType
        {
            get
            {
                return m_primaryBarType;
            }
            set
            {
                m_primaryBarType = value;
            }
        }

        /// <summary>
        /// Primary bar length of path reinforcement,get/set property.
        /// </summary>
        [Category("Layers"), DisplayName("Primary Bar - Length")]
        public String PrimaryBarLength
        {
            get
            {
                return m_primaryBarLength;

            }
            set
            {
                if (!ValidateInch(value))
                {
                    throw new Exception("Invalid value.");
                }
                m_primaryBarLength = value;
            }
        }

        /// <summary>
        /// Face of path reinforcement, get/set property.
        /// </summary>
        [Category("Layers"), DisplayName("Face")]
        public Face Face
        {
            get
            {
                return m_face;
            }
            set
            {
                m_face = value;
            }
        }

        /// <summary>
        /// Get parameter by given name.
        /// </summary>
        /// <param name="name">name of parameter</param>
        /// <returns>parameter whose definition name is the given name.</returns>
        protected Parameter GetParameter(String name)
        {
            foreach (Parameter para in m_pathRein.Parameters)
            {
                if (para.Definition.Name.Equals(name))
                {
                    return para;
                }
            }
            return null;
        }

        /// <summary>
        /// set some properties to read only or not
        /// </summary>
        /// <param name="propertyName">name of property</param>
        /// <param name="readOnly">read only or not</param>
        void SetPropertyReadOnly(string propertyName, bool readOnly)
        {
            string strEx = string.Empty;
            try
            {
                Type type = typeof(System.ComponentModel.ReadOnlyAttribute);
                PropertyDescriptorCollection props = TypeDescriptor.GetProperties(this);
                AttributeCollection attrs = props[propertyName].Attributes;
                FieldInfo fld = type.GetField("<IsReadOnly>k__BackingField", BindingFlags.Instance | BindingFlags.NonPublic);
                if (fld != null)
                {
                   fld.SetValue(attrs[type], readOnly);
                }
            }
            catch (System.ArgumentException ex)
            {
                strEx = ex.ToString();
            }
            catch (FieldAccessException ex)
            {
                strEx = ex.ToString();
            }
            catch (System.Reflection.TargetException ex)
            {
                strEx = ex.ToString();
            }
            catch (Exception ex)
            {
                strEx = ex.ToString();
            }

            // exception occurs?
            if (strEx != string.Empty)
            {
                throw new Exception(strEx);
            }
        }

        /// <summary>
        /// validate inch like this 124'- 9".
        /// </summary>
        /// <param name="input">input string</param>
        /// <returns>true if input string is a valid inch.</returns>
        private Boolean ValidateInch(String input)
        {
            // check whether the input string is a valid double value.
            // if it's true, return directly, otherwise parse the string.
            try
            {
                Double.Parse(input);
                return true;
            }
            catch (Exception) 
            { 
                // reasonable exception.
                // continue to parse the string in below lines if exception occurs.
            }

            String inputTrim = input.Trim();
            int number = 0;     // number [0, 9].
            int sQuotation = 0; // single quotation mark.
            int dQuotation = 0; // double quotation mark.
            int hLine = 0;      // char '-' mark

            foreach (Char ch in inputTrim)
            {
                if (dQuotation > 0)
                {
                    return false;
                }

                if ('0' <= ch && ch <= '9')
                {
                    number++;
                }
                else if (ch.Equals('\''))
                {
                    if (sQuotation > 0 || number == 0)
                    {
                        return false;
                    }
                    sQuotation++;
                    number = 0;
                }
                else if (ch.Equals('\"'))
                {
                    if (dQuotation > 0 || number == 0)
                    {
                        return false;
                    }
                    dQuotation++;
                    number = 0;
                }
                else if (ch.Equals('-'))
                {
                    if (hLine != 0 || sQuotation == 0 || (sQuotation != 0 && number != 0))
                    {
                        return false;
                    }
                    hLine++;
                    number = 0;
                }
                else if (ch.Equals(' '))
                {
                    // skip the white space
                }
                else
                {
                    return false;
                }
            }

            //check whether the parsed string is valid.
            int length = inputTrim.Length;
            Char last = inputTrim[length - 1];
            if (dQuotation > 0 && !last.Equals('\"'))
            {
                return false;
            }

            if (sQuotation > 0 && dQuotation == 0 && !last.Equals('\''))
            {
                return false;
            }
            return true;
        }
    };
}