using UnityEngine.Perception.GroundTruth.DataModel;

namespace UnityEngine.Perception.GroundTruth
{
    public abstract class ConsumerEndpoint : MonoBehaviour
    {
        /// <summary>
        /// Called when the simulation begins. Provides simulation wide metadata to
        /// the consumer.
        /// </summary>
        /// <param name="metadata">Metadata describing the active simulation</param>
        public abstract void OnSimulationStarted(SimulationMetadata metadata);

        public virtual void OnSensorRegistered(SensorDefinition sensor) { }

        public virtual void OnAnnotationRegistered(AnnotationDefinition annotationDefinition) { }
        public virtual void OnMetricRegistered(MetricDefinition metricDefinition) { }

        /// <summary>
        /// Called at the end of each frame. Contains all of the generated data for the
        /// frame. This method is called after the frame has entirely finished processing.
        /// </summary>
        /// <param name="frame">The frame data.</param>
        public abstract void OnFrameGenerated(Frame frame);

        /// <summary>
        /// Called at the end of the simulation. Contains metadata describing the entire
        /// simulation process.
        /// </summary>
        /// <param name="metadata">Metadata describing the entire simulation process</param>
        public abstract void OnSimulationCompleted(CompletionMetadata metadata);
    }
}