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/audibility_filter/filter_condition_interface.h>

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

// Vista includes
#include <VistaAspects/VistaPropertyList.h>

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 IAudibilityFilter::AudibilityFilterConfig& );
			/// \endcode
			/// 
			class ITA_SIMULATION_SCHEDULER_API IAudibilityFilter
			{
			public:
				///
				/// \brief Configuration class for an audibility filter.
				///
				struct ITA_SIMULATION_SCHEDULER_API AudibilityFilterConfig : public VistaPropertyList
				{
					///
					/// \brief Set the condition filter config of the AudibilityFilterConfig.
					///
					/// The order of the condition filters is also saved in the config.
					/// \param vFilterConfig all filter to add to the config.
					/// \todo Do we set or add filter configs? If we set, do we overwrite?
					///
					void setConditionFilterConfig (	const std::vector<IFilterCondition::FilterConditionConfig>& vFilterConfig );

					///
					/// \brief Get all condition filter configs from the AudibilityFilterConfig.
					///
					/// The order in which the condition filters were set in the config is also represented in the vector.
					/// \return a vector with all condition filter configs.
					///
					std::vector<IFilterCondition::FilterConditionConfig> getConditionFilterConfig ( ) const;
				};

				///
				/// \brief Constructor for IAudibilityFilter.
				///
				/// This constructor configures the condition filters of the IAudibilityFilter.
				/// \param oConfig the AudibilityFilterConfig used to configure the IAudibilityFilter.
				/// 
				explicit IAudibilityFilter ( const AudibilityFilterConfig& oConfig );

				///
				/// \brief Pure virtual destructor.
				/// 
				virtual ~IAudibilityFilter ( ) = 0;

				IAudibilityFilter ( const IAudibilityFilter& other ) = delete;

				IAudibilityFilter& operator=( const IAudibilityFilter& other ) = delete;

				///
				/// \brief Check if the change between \p previousState and \p newUpdate is audible.
				///
				/// \note Default behaviour it to return the default result of IFilterCondition::conditionFulfilled.
				/// \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 );

			protected:
				///
				/// \brief Check if all conditions are met.
				///
				/// This functions calls IFilterCondition::conditionFulfilled of all IFilterCondition%s in ::m_lpConditionFilters.
				/// \param previousState the previous state of the scene to check against.
				/// \param newUpdate the CUpdateScene to check for audibility.
				/// \return true, if all conditions are fulfilled.
				///
				bool checkAllConditions ( const CUpdateScene& previousState, const CUpdateScene& newUpdate );

				///
				/// \brief Vector of the condition filters belonging to IAudibilityFilter.
				/// 
				std::vector<std::unique_ptr<IFilterCondition>> m_lpConditionFilters;
			};

			///
			/// \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.
			///
			class ITA_SIMULATION_SCHEDULER_API CAudibilityFilterFactory
			{
			public:
				///
				/// \brief The function signature for a create function.
				///
				typedef std::function<std::unique_ptr<IAudibilityFilter> ( const IAudibilityFilter::AudibilityFilterConfig& )> 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 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