ml-agents/com.unity.ml-agents/Runtime/Sensors/Reflection/ReflectionSensorBase.cs

using System.Reflection;

namespace Unity.MLAgents.Sensors.Reflection
{
    /// <summary>
    /// Construction info for a ReflectionSensorBase.
    /// </summary>
    internal struct ReflectionSensorInfo
    {
        public object Object;

        public FieldInfo FieldInfo;
        public PropertyInfo PropertyInfo;
        public ObservableAttribute ObservableAttribute;
        public string SensorName;
    }

    /// <summary>
    /// Abstract base class for reflection-based sensors.
    /// </summary>
    internal abstract class ReflectionSensorBase : ISensor
    {
        protected object m_Object;

        // Exactly one of m_FieldInfo and m_PropertyInfo should be non-null.
        protected FieldInfo m_FieldInfo;
        protected PropertyInfo m_PropertyInfo;

        // Not currently used, but might want later.
        protected ObservableAttribute m_ObservableAttribute;

        // Cached sensor names and shapes.
        string m_SensorName;
        int[] m_Shape;

        public ReflectionSensorBase(ReflectionSensorInfo reflectionSensorInfo, int size)
        {
            m_Object = reflectionSensorInfo.Object;
            m_FieldInfo = reflectionSensorInfo.FieldInfo;
            m_PropertyInfo = reflectionSensorInfo.PropertyInfo;
            m_ObservableAttribute = reflectionSensorInfo.ObservableAttribute;
            m_SensorName = reflectionSensorInfo.SensorName;
            m_Shape = new[] {size};
        }

        /// <inheritdoc/>
        public int[] GetObservationShape()
        {
            return m_Shape;
        }

        /// <inheritdoc/>
        public int Write(ObservationWriter writer)
        {
            WriteReflectedField(writer);
            return m_Shape[0];
        }

        internal abstract void WriteReflectedField(ObservationWriter writer);

        /// <summary>
        /// Get either the reflected field, or return the reflected property.
        /// This should be used by implementations in their WriteReflectedField() method.
        /// </summary>
        /// <returns></returns>
        protected object GetReflectedValue()
        {
            return m_FieldInfo != null ?
                m_FieldInfo.GetValue(m_Object) :
                m_PropertyInfo.GetMethod.Invoke(m_Object, null);
        }

        /// <inheritdoc/>
        public byte[] GetCompressedObservation()
        {
            return null;
        }

        /// <inheritdoc/>
        public void Update() {}

        /// <inheritdoc/>
        public void Reset() {}

        /// <inheritdoc/>
        public SensorCompressionType GetCompressionType()
        {
            return SensorCompressionType.None;
        }

        /// <inheritdoc/>
        public string GetName()
        {
            return m_SensorName;
        }
    }
}