/***************************************************************************
 * Copyright (C) GFZ Potsdam                                               *
 * All rights reserved.                                                    *
 *                                                                         *
 * GNU Affero General Public License Usage                                 *
 * This file may be used under the terms of the GNU Affero                 *
 * Public License version 3.0 as published by the Free Software Foundation *
 * and appearing in the file LICENSE included in the packaging of this     *
 * file. Please review the following information to ensure the GNU Affero  *
 * Public License version 3.0 requirements will be met:                    *
 * https://www.gnu.org/licenses/agpl-3.0.html.                             *
 ***************************************************************************/


#ifndef SEISCOMP_APPLICATIONS_EVENTPROCESSOR_H
#define SEISCOMP_APPLICATIONS_EVENTPROCESSOR_H


#include <string>
#include <list>

#include <seiscomp/core/baseobject.h>
#include <seiscomp/core/interfacefactory.h>
#include <seiscomp/config/config.h>
#include <seiscomp/plugins/events/api.h>


/******************************************************************************
 scevent API Changelog
 ******************************************************************************
 4
   - Added preferredMagnitude()
 3
   - Added newEvent flag to process()
 2
   - Added list of event journal entries to process()

 <undefined>
   - Initial API
 */
#define SCEVENT_EVENTPROCESSOR_API_VERSION 4


namespace Seiscomp {


namespace DataModel {

class Magnitude;
class Origin;
class Event;
DEFINE_SMARTPOINTER(JournalEntry);

}


namespace Client {


DEFINE_SMARTPOINTER(EventProcessor);


class SC_EVPLUGIN_API EventProcessor : public Seiscomp::Core::BaseObject {
	// ----------------------------------------------------------------------
	// Public types
	// ----------------------------------------------------------------------
	public:
		typedef std::list<DataModel::JournalEntryPtr> Journal;


	// ----------------------------------------------------------------------
	// X'truction
	// ----------------------------------------------------------------------
	public:
		EventProcessor();


	// ----------------------------------------------------------------------
	// Virtual public interface
	// ----------------------------------------------------------------------
	public:
		/**
		 * @brief Setup all configuration parameters
		 * @param config The application configuration
		 * @return Success flag
		 */
		virtual bool setup(const Config::Config &config) = 0;


		/**
		 * @brief Selects the preferred magnitude of an origin.
		 * @param origin The origin to be processed.
		 * @return Either the preferred magnitude or nullptr.
		 */
		virtual DataModel::Magnitude *preferredMagnitude(const DataModel::Origin *origin) = 0;


		/**
		 * @brief Processes an event.
		 * The preferred object (Origin, Magnitude, FocalMechanism) are
		 * guaranteed to be found with *::Find(id) methods.
		 * This method should return true if the event objects needs an
		 * update.
		 * @param event The event to be processed.
		 * @param isNewEvent Whether the event is a new event or an updated event.
		 * @param journals The list of current event journals.
		 */
		virtual bool process(DataModel::Event *event,
		                     bool isNewEvent,
		                     const Journal &journals) = 0;
};


DEFINE_INTERFACE_FACTORY(EventProcessor);


}
}


#define REGISTER_EVENTPROCESSOR(Class, Service) \
Seiscomp::Core::Generic::InterfaceFactory<Seiscomp::Client::EventProcessor, Class> __##Class##InterfaceFactory__(Service)


#endif