#ifndef MASK_HPP_INCLUDED
#define MASK_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/BinData.h>
#include <NBO/NBO/Shape_Type.h>
#include <NBO/NBO/ENBOType.h>
#include <NBO/NBOGlobal.h>
#include <NBO/Shared/Base/NBOBaseClass.h>


namespace Inscoper::NBO {

/*!
* \brief Represents the XML element Mask.
*
* The Mask ROI shape is a link to a BinData object that is a BIT mask drawn on top of the Image as an ROI. It is applied at the same scale, Pixel to Pixel, as the Image the ROI is applied to, unless a transform is applied at the shape level. 
*/
class NBO_EXPORT Mask : public Shape_Type {

public:
	
	Mask();
	~Mask();

	/*!
	* \brief Cast a NBOBaseClass to a Mask.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<Mask> fromBase(NBOBaseClassPtr base);

	/*!
	* \brief Returns the class type name.
	*
	* \return The class type name
	*/
	std::string getTypeName() const override;

	/*!
	* \brief Returns the XML element name corresponding to this class.
	*
	* \return The XML element name
	*/
	std::string getXMLName() const override;

	/*!
	* \brief Returns the NBO Type corresponding to this class.
	*
	* \return The NBO Type value
	*/
	ENBOType getNBOType() const override;

	/*!
	* \brief Returns a list of all classes derived from this class.
	*
	* \return The list of derived classes
	*/
	std::vector<NBOBaseClassPtr> getChildren() const override;

	/*!
	* \brief Returns a list of all child elements contained in this class.
	*
	* \return The list of child classes
	*/
	std::vector<NBOBaseClassPtr> getSubElements() const override;

	/*!
	* \brief Populates this object from a JSON file.
	*
	* \param path The path to the JSON file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a JSON string.
	*
	* \param json_string The JSON content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonString(const std::string& json_string, bool validate = true);

	/*!
	* \brief Populates this object from a XML file.
	*
	* \param path The path to the XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a XML string.
	*
	* \param xml_string The XML content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlString(const std::string& xml_string, bool validate = true);

	/*!
	* \brief Serializes this object to an XML file.
	*
	* \param filename The path to the output XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void toXmlFile(const std::string& filename, bool validate = true) const;

	/*!
	* \brief Serializes this object to an XML string.
	*
	* \param validate If true, validates constraints on value. Default is true.
	* \return A string containing the XML representation of this object
	*/
	std::string toXmlString(bool validate = true) const;

	/*!
	* \brief Sets the value of the X attribute.
	*
	* The X coordinate of the left side of the Image. [units pixels] 
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setX(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the X attribute.
	*
	* The X coordinate of the left side of the Image. [units pixels] 
	*
	* \return The value of the attribute
	*/
	float getX() const;

	/*!
	* \brief Resets the X attribute to an unset state.
	*
	* The X coordinate of the left side of the Image. [units pixels] 
	*/
	void resetX();

	/*!
	* \brief Checks whether the X attribute is present.
	*
	* The X coordinate of the left side of the Image. [units pixels] 
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasX() const;

	/*!
	* \brief Sets the value of the Y attribute.
	*
	* The Y coordinate of the top side of the Image. [units pixels] 
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setY(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the Y attribute.
	*
	* The Y coordinate of the top side of the Image. [units pixels] 
	*
	* \return The value of the attribute
	*/
	float getY() const;

	/*!
	* \brief Resets the Y attribute to an unset state.
	*
	* The Y coordinate of the top side of the Image. [units pixels] 
	*/
	void resetY();

	/*!
	* \brief Checks whether the Y attribute is present.
	*
	* The Y coordinate of the top side of the Image. [units pixels] 
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasY() const;

	/*!
	* \brief Sets the value of the Width attribute.
	*
	* The width of the mask. [units pixels] 
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setWidth(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the Width attribute.
	*
	* The width of the mask. [units pixels] 
	*
	* \return The value of the attribute
	*/
	float getWidth() const;

	/*!
	* \brief Resets the Width attribute to an unset state.
	*
	* The width of the mask. [units pixels] 
	*/
	void resetWidth();

	/*!
	* \brief Checks whether the Width attribute is present.
	*
	* The width of the mask. [units pixels] 
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasWidth() const;

	/*!
	* \brief Sets the value of the Height attribute.
	*
	* The height of the mask. [units pixels] 
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setHeight(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the Height attribute.
	*
	* The height of the mask. [units pixels] 
	*
	* \return The value of the attribute
	*/
	float getHeight() const;

	/*!
	* \brief Resets the Height attribute to an unset state.
	*
	* The height of the mask. [units pixels] 
	*/
	void resetHeight();

	/*!
	* \brief Checks whether the Height attribute is present.
	*
	* The height of the mask. [units pixels] 
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasHeight() const;

	/*!
	* \brief Sets the value of the BinData element.
	*
	* No description available in the XSD standard.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setBinData(const Inscoper::NBO::BinDataPtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the BinData element.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the element
	*/
	Inscoper::NBO::BinDataPtr getBinData() const
;
	/*!
	* \brief Resets the BinData element to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetBinData();

	/*!
	* \brief Checks whether the optional BinData element is present.
	*
	* No description available in the XSD standard.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasBinData() const;


private:
	class Impl;
	std::unique_ptr<Impl> pImpl;

    std::optional<float> X; // Required attribute
    std::optional<float> Y; // Required attribute
    std::optional<float> Width; // Required attribute
    std::optional<float> Height; // Required attribute
    Inscoper::NBO::BinDataPtr BinData = nullptr;
};

/*! Shared pointer for Mask*/
typedef std::shared_ptr<Mask> MaskPtr;

} // namespace Inscoper::NBO

#endif // MASK_HPP_INCLUDED