#ifndef SAMPLEHOLDER_HPP_INCLUDED
#define SAMPLEHOLDER_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/ENBOType.h>
#include <NBO/NBOGlobal.h>
#include <NBO/Shared/Base/NBOBaseClass.h>


namespace Inscoper::NBO {

/*!
* \brief Represents the XML element SampleHolder.
*
* This element describes the device (often referred to as Sample Carrier, Container or Vessel) on which the specimen was mounted for microscopical examination. It typically is flat and it could be made of glass or plastic. Examples include Microscope slides, Petri dishes, and multi-well plates.
*/
class NBO_EXPORT SampleHolder : public ManufacturerSpec_Type {

public:
	
	SampleHolder();
	~SampleHolder();

	/*!
	* \brief Cast a NBOBaseClass to a SampleHolder.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<SampleHolder> 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 Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
	*
	* \return The value of the attribute
	*/
	std::string getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
	*/
	void resetType();

	/*!
	* \brief Checks whether the Type attribute is present.
	*
	* This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasType() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getTypeAllowedValues();


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

	LSID_TypePtr ID = nullptr; // Required attribute
    std::optional<std::string> Type; // Required attribute
    static const std::set<std::string> TypeAllowedValues;
};

/*! Shared pointer for SampleHolder*/
typedef std::shared_ptr<SampleHolder> SampleHolderPtr;

} // namespace Inscoper::NBO

#endif // SAMPLEHOLDER_HPP_INCLUDED