#ifndef MOUNTINGMEDIUM_HPP_INCLUDED
#define MOUNTINGMEDIUM_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/LSID_Type.h>
#include <NBO/NBO/ManufacturerSpec_Type.h>
#include <NBO/NBO/MountingMediumType_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 MountingMedium.
*
* This element refers to the Mounting Medium that was used during the acquisition of this Image. According to ISO 10934-1:2002, a Mounting Medium is a liquid, synthetic resin or other medium in which this Specimen is placed during Image Acquisition. NOTE For fixed Samples observed by transmitted-light microscopy, this Medium is transparent, colourless and of specified refractive index, enclosed between the slide and the cover glass. For reflected-light microscopy, the mounting medium is normally a resin with which the Sample is impregnated so that a polished section may be made. For live Samples, the Medium is typically the tissue culture growth substrate.
*/
class NBO_EXPORT MountingMedium : public ManufacturerSpec_Type {

public:
	
	MountingMedium();
	~MountingMedium();

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

	/*!
	* \brief Returns the value of the ID attribute.
	*
	* A Unique Identifier for this component.
	*
	* \return The value of the attribute
	*/
	LSID_TypePtr getID() const;

	/*!
	* \brief Resets the ID attribute to an unset state.
	*
	* A Unique Identifier for this component.
	*/
	void resetID();

	/*!
	* \brief Checks whether the optional ID attribute is present.
	*
	* A Unique Identifier for this component.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasID() const;

	/*!
	* \brief Sets the value of the Type attribute.
	*
	* This field records the general category to which this Mounting Medium belongs.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const Inscoper::NBO::MountingMediumType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field records the general category to which this Mounting Medium belongs.
	*
	* \return The value of the attribute
	*/
	MountingMediumType_TypePtr getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field records the general category to which this Mounting Medium belongs.
	*/
	void resetType();

	/*!
	* \brief Checks whether the optional Type attribute is present.
	*
	* This field records the general category to which this Mounting Medium belongs.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasType() const;

	/*!
	* \brief Sets the value of the RefractiveIndex attribute.
	*
	* This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setRefractiveIndex(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the RefractiveIndex attribute.
	*
	* This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.
	*
	* \return The value of the attribute
	*/
	float getRefractiveIndex() const;

	/*!
	* \brief Resets the RefractiveIndex attribute to an unset state.
	*
	* This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.
	*/
	void resetRefractiveIndex();

	/*!
	* \brief Checks whether the RefractiveIndex attribute is present.
	*
	* This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasRefractiveIndex() const;


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

	LSID_TypePtr ID = nullptr; // Required attribute
	MountingMediumType_TypePtr Type = nullptr; // Required attribute
    std::optional<float> RefractiveIndex; // Required attribute
};

/*! Shared pointer for MountingMedium*/
typedef std::shared_ptr<MountingMedium> MountingMediumPtr;

} // namespace Inscoper::NBO

#endif // MOUNTINGMEDIUM_HPP_INCLUDED