audibility_filter_interface.h

#ifndef INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_AUDIBILITY_FILTER_AUDIBILITY_FILTER_INTERFACE
#define INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_AUDIBILITY_FILTER_AUDIBILITY_FILTER_INTERFACE

// API includes
#include <ITA/simulation_scheduler/definitions.h>

// simulation scheduler includes
#include <ITA/simulation_scheduler/config_interface.h>

// std includes
#include <memory>
#include <functional>
#include <vector>

namespace ITA
{
	namespace simulation_scheduler
	{
		class CUpdateScene;

		namespace audibility_filter
		{
			///
			/// \brief The interface for an audibility filter.
			///
			/// An audibility filter is used to determine the audibility of the change between two CUpdateScenes.
			///
			/// An audibility filter is created by CAudibilityFilterFactory.
			/// For this, a function like this is necessary:
			/// \code{.cpp}
			/// ///
			/// /// \brief Factory function for an audibility filter.
			/// /// \remark This function should to be static.
			/// ///
			/// static std::unique_ptr<IAudibilityFilter> createFilter ( const std::shared_ptr<IAudibilityFilter::AudibilityFilterConfig>& pConfig );
			/// \endcode
			/// 
			class ITA_SIMULATION_SCHEDULER_API IAudibilityFilter
			{
			public:
				///
				/// \brief Usage mode for audibility filter.
				/// 
				enum class UsageMode
				{
					filter,   ///< Use the audibility filter as an actual filter.
					condition ///< Use the audibility filter as a condition for following filters.
				};
				
				///
				/// \brief Base configuration class for audibility filter.
				///
				/// \note ::sFilterType is a read only property of the AudibilityFilterConfig.
				/// Due to this the copy constructor and assignment operator are needed.
				///
				struct ITA_SIMULATION_SCHEDULER_API AudibilityFilterConfig : public IConfig
				{
					AudibilityFilterConfig ( );
					
					explicit AudibilityFilterConfig ( std::string sType );

					AudibilityFilterConfig ( const AudibilityFilterConfig& other );

					AudibilityFilterConfig& operator=( const AudibilityFilterConfig& other );

					std::string sFilterName = "Unknown";
					
					const std::string& sFilterType; 

					std::vector<std::string> sNextFilter;
					
					UsageMode eUsageMode = UsageMode::filter;

					bool bInvertCondition = false;
					
					VistaPropertyList store() const override = 0;

					void load(const VistaPropertyList& oProperties) override = 0;

				private:
					std::string m_sFilterType;
				};

				///
				/// \brief Check if the change between \p previousState and \p newUpdate is audible.
				/// \param previousState the previous state of the scene to check against.
				/// \param newUpdate the CUpdateScene to check for audibility.
				/// \return true if the change between \p previousState and \p newUpdate is audible, else false.
				///
				virtual bool changeIsAudible ( const CUpdateScene& previousState, const CUpdateScene& newUpdate ) const = 0;

			protected:
				///
				/// \brief Checks weather the \p newUpdate happened after \p previousState.
				/// \note This method should be called first in every ::changeIsAudible.
				/// \throws ITAExcept when \p previousState happened after \p newUpdate.
				/// \param previousState CUpdateScene of the previous state.
				/// \param newUpdate new CUpdateScene.
				/// 
				static void checkUpdateTimestamp ( const CUpdateScene& previousState, const CUpdateScene& newUpdate );
			};

			///
			/// \brief Factory class for filter.
			///
			/// This class implements an extensible factory for filter.
			/// After a type of filter is registered with its IAudibilityFilter::createFilter, it can be created using this factory.
			/// \todo Add a way to get the correct config from the type. The factory already knows of all possible filters.
			///
			class ITA_SIMULATION_SCHEDULER_API CAudibilityFilterFactory
			{
			public:
				///
				/// \brief The function signature for a create function.
				///
				typedef std::function<std::unique_ptr<IAudibilityFilter> ( const std::shared_ptr<IAudibilityFilter::AudibilityFilterConfig>& pConfig )> CreateCallback;

				///
				/// \brief Register a type of filter to the factory.
				/// \param type name of the filter type to be registered.
				/// \param createFunction the corresponding create function.
				///
				static void registerFilter ( const std::string& type, CreateCallback createFunction );

				///
				/// \brief Unregister a type of filter from the factory.
				/// \param type name of the filter type to be removed.
				///
				static void unregisterFilter ( const std::string& type );

				///
				/// \brief Factory method.
				/// \param pConfig the configuration for the filter.
				/// \return a pointer to the created filter.
				///
				static std::unique_ptr<IAudibilityFilter> createFilter ( const std::shared_ptr<IAudibilityFilter::AudibilityFilterConfig>& pConfig );

			private:
				///
				/// \brief Map containing all creation functions.
				///
				static std::map<std::string, CreateCallback> m_mFilters;
			};
		} // namespace audibility_filter
	} // namespace simulation_scheduler
} // namespace ITA

#endif // INCLUDE_WATCHER_ITA_SIMULATION_SCHEDULER_AUDIBILITY_FILTER_AUDIBILITY_FILTER_INTERFACE