UA-.NETStandard/Libraries/Opc.Ua.Client.ComplexTypes/IComplexTypeProperties.cs

/* ========================================================================
 * Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 * 
 * 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.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Runtime.Serialization;

namespace Opc.Ua.Client.ComplexTypes
{
    /// <summary>
    /// Attribute for a complex type property.
    /// </summary>
    public class ComplexTypePropertyAttribute
    {
        /// <inheritdoc cref="System.Reflection.PropertyInfo"/>
        public readonly PropertyInfo PropertyInfo;

        /// <summary>
        /// The structure field attributes of the complex type.
        /// </summary>
        public readonly StructureFieldAttribute FieldAttribute;

        /// <summary>
        /// The data attributes of the complex type.
        /// </summary>
        public readonly DataMemberAttribute DataAttribute;

        /// <summary>
        /// Create the attributes for the complex type.
        /// </summary>
        public ComplexTypePropertyAttribute(
            PropertyInfo propertyInfo,
            StructureFieldAttribute fieldAttribute,
            DataMemberAttribute dataAttribute
            )
        {
            PropertyInfo = propertyInfo;
            FieldAttribute = fieldAttribute;
            DataAttribute = dataAttribute;
        }

        /// <summary>
        /// Get the name of the complex type.
        /// </summary>
        public string Name => PropertyInfo.Name;

        /// <summary>
        /// Get the value of a property.
        /// </summary>
        public object GetValue(object o)
        {
            return PropertyInfo.GetValue(o);
        }

        /// <summary>
        /// Set the value of a property.
        /// </summary>
        public void SetValue(object o, object v)
        {
            PropertyInfo.SetValue(o, v);
        }

        /// <inheritdoc cref="PropertyInfo.PropertyType"/>
        public Type PropertyType => PropertyInfo.PropertyType;

        /// <inheritdoc cref="StructureFieldAttribute.IsOptional"/>
        public bool IsOptional => FieldAttribute.IsOptional;

        /// <inheritdoc cref="StructureFieldAttribute.ValueRank"/>
        public int ValueRank => FieldAttribute.ValueRank;

        /// <inheritdoc cref="DataMemberAttribute.Order"/>
        public int Order => DataAttribute.Order;

        /// <summary>
        /// Optional mask for the field in the property.
        /// </summary>
        public UInt32 OptionalFieldMask;
    }

    /// <summary>
    /// Interface to access properties of a complex type.
    /// </summary>
    public interface IComplexTypeProperties
    {
        /// <summary>
        /// Get count of properties.
        /// </summary>
        int GetPropertyCount();

        /// <summary>
        /// Get ordered list of property names.
        /// </summary>
        IList<String> GetPropertyNames();

        /// <summary>
        /// Get ordered list of property types.
        /// </summary>
        IList<Type> GetPropertyTypes();

        /// <summary>
        /// Access property values by index.
        /// </summary>
        object this[int index] { get; set; }

        /// <summary>
        /// Access property values by name.
        /// </summary>
        object this[string name] { get; set; }

        /// <summary>
        /// Ordered enumerator for properties.
        /// </summary>
        IEnumerable<ComplexTypePropertyAttribute> GetPropertyEnumerator();
    }
}//namespace