#ifndef MICROSCOPESTANDSETTINGS_HPP_INCLUDED
#define MICROSCOPESTANDSETTINGS_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/MicroscopeID_Type.h>
#include <NBO/NBO/Settings_Type.h>
#include <NBO/NBO/UnitsLength_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 MicroscopeStandSettings.
*
* This element refers to the Microscope Stand used to acquire this Image and it holds the Settings that were applied to the Microscope Stand during this Acquisition.
*/
class NBO_EXPORT MicroscopeStandSettings : public Settings_Type {

public:
	
	MicroscopeStandSettings();
	~MicroscopeStandSettings();

	/*!
	* \brief Cast a NBOBaseClass to a MicroscopeStandSettings.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<MicroscopeStandSettings> 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 ID attribute.
	*
	* This is the Unique Identifier of the Microscope used in this case.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setID(const Inscoper::NBO::MicroscopeID_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the ID attribute.
	*
	* This is the Unique Identifier of the Microscope used in this case.
	*
	* \return The value of the attribute
	*/
	MicroscopeID_TypePtr getID() const;

	/*!
	* \brief Resets the ID attribute to an unset state.
	*
	* This is the Unique Identifier of the Microscope used in this case.
	*/
	void resetID();

	/*!
	* \brief Checks whether the optional ID attribute is present.
	*
	* This is the Unique Identifier of the Microscope used in this case.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasID() const;

	/*!
	* \brief Sets the value of the TotalEffectiveMagnification attribute.
	*
	* This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setTotalEffectiveMagnification(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the TotalEffectiveMagnification attribute.
	*
	* This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.
	*
	* \return The value of the attribute
	*/
	float getTotalEffectiveMagnification() const;

	/*!
	* \brief Resets the TotalEffectiveMagnification attribute to an unset state.
	*
	* This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.
	*/
	void resetTotalEffectiveMagnification();

	/*!
	* \brief Checks whether the TotalEffectiveMagnification attribute is present.
	*
	* This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasTotalEffectiveMagnification() const;

	/*!
	* \brief Sets the value of the FieldOfView attribute.
	*
	* The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setFieldOfView(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the FieldOfView attribute.
	*
	* The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.
	*
	* \return The value of the attribute
	*/
	float getFieldOfView() const;

	/*!
	* \brief Resets the FieldOfView attribute to an unset state.
	*
	* The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.
	*/
	void resetFieldOfView();

	/*!
	* \brief Checks whether the FieldOfView attribute is present.
	*
	* The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasFieldOfView() const;

	/*!
	* \brief Sets the value of the FieldOfViewUnit attribute.
	*
	* 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 setFieldOfViewUnit(const Inscoper::NBO::UnitsLength_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the FieldOfViewUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the attribute
	*/
	UnitsLength_TypePtr getFieldOfViewUnit() const;

	/*!
	* \brief Resets the FieldOfViewUnit attribute to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetFieldOfViewUnit();

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


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

	MicroscopeID_TypePtr ID = nullptr; // Optional attribute
    std::optional<float> TotalEffectiveMagnification; // Optional attribute
    std::optional<float> FieldOfView; // Optional attribute
	UnitsLength_TypePtr FieldOfViewUnit = nullptr; // Optional attribute
};

/*! Shared pointer for MicroscopeStandSettings*/
typedef std::shared_ptr<MicroscopeStandSettings> MicroscopeStandSettingsPtr;

} // namespace Inscoper::NBO

#endif // MICROSCOPESTANDSETTINGS_HPP_INCLUDED