#ifndef STAGEINSERT_HPP_INCLUDED
#define STAGEINSERT_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/AnnotationRef.h>
#include <NBO/NBO/Denomination_Type.h>
#include <NBO/NBO/ManufacturerSpec_Type.h>
#include <NBO/NBO/SampleHolderType_Type.h>
#include <NBO/NBO/StageInsertID_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 StageInsert.
*
* This element describes an optional Stage Insert mounted on the Stage.
*/
class NBO_EXPORT StageInsert : public ManufacturerSpec_Type {

public:
	
	StageInsert();
	~StageInsert();

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

	/*!
	* \brief Returns the value of the Name attribute.
	*
	* A User-defined Name for this component.
	*
	* \return The value of the attribute
	*/
	Denomination_TypePtr getName() const;

	/*!
	* \brief Resets the Name attribute to an unset state.
	*
	* A User-defined Name for this component.
	*/
	void resetName();

	/*!
	* \brief Checks whether the optional Name attribute is present.
	*
	* A User-defined Name for this component.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasName() const;

	/*!
	* \brief Sets the value of the SampleHolderType attribute.
	*
	* This field describes the type of Specimen Holder this Stage Insert is designed to hold.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setSampleHolderType(const Inscoper::NBO::SampleHolderType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the SampleHolderType attribute.
	*
	* This field describes the type of Specimen Holder this Stage Insert is designed to hold.
	*
	* \return The value of the attribute
	*/
	SampleHolderType_TypePtr getSampleHolderType() const;

	/*!
	* \brief Resets the SampleHolderType attribute to an unset state.
	*
	* This field describes the type of Specimen Holder this Stage Insert is designed to hold.
	*/
	void resetSampleHolderType();

	/*!
	* \brief Checks whether the optional SampleHolderType attribute is present.
	*
	* This field describes the type of Specimen Holder this Stage Insert is designed to hold.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasSampleHolderType() const;

	/*!
	* \brief Sets the value of the TemperatureControlled attribute.
	*
	* This field records whether this Stage Insert is Temperature Controlled (True), or not (False).
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setTemperatureControlled(const bool& value, bool validate = true);

	/*!
	* \brief Returns the value of the TemperatureControlled attribute.
	*
	* This field records whether this Stage Insert is Temperature Controlled (True), or not (False).
	*
	* \return The value of the attribute
	*/
	bool getTemperatureControlled() const;

	/*!
	* \brief Resets the TemperatureControlled attribute to an unset state.
	*
	* This field records whether this Stage Insert is Temperature Controlled (True), or not (False).
	*/
	void resetTemperatureControlled();

	/*!
	* \brief Checks whether the TemperatureControlled attribute is present.
	*
	* This field records whether this Stage Insert is Temperature Controlled (True), or not (False).
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasTemperatureControlled() const;

	/*!
	* \brief Sets the value of the NumberOfSlots attribute.
	*
	* This field describes the number of Specimen Holder slots on this Stage Insert.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setNumberOfSlots(const long long& value, bool validate = true);

	/*!
	* \brief Returns the value of the NumberOfSlots attribute.
	*
	* This field describes the number of Specimen Holder slots on this Stage Insert.
	*
	* \return The value of the attribute
	*/
	long long getNumberOfSlots() const;

	/*!
	* \brief Resets the NumberOfSlots attribute to an unset state.
	*
	* This field describes the number of Specimen Holder slots on this Stage Insert.
	*/
	void resetNumberOfSlots();

	/*!
	* \brief Checks whether the NumberOfSlots attribute is present.
	*
	* This field describes the number of Specimen Holder slots on this Stage Insert.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasNumberOfSlots() const;

	/*!
	* \brief Sets the value of the AnnotationRef 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 setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr& value, bool validate = true);

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

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


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

	StageInsertID_TypePtr ID = nullptr; // Optional attribute
	Denomination_TypePtr Name = nullptr; // Optional attribute
	SampleHolderType_TypePtr SampleHolderType = nullptr; // Required attribute
    std::optional<bool> TemperatureControlled; // Required attribute
    std::optional<long long> NumberOfSlots; // Optional attribute
    Inscoper::NBO::AnnotationRefPtr AnnotationRef = nullptr;
};

/*! Shared pointer for StageInsert*/
typedef std::shared_ptr<StageInsert> StageInsertPtr;

} // namespace Inscoper::NBO

#endif // STAGEINSERT_HPP_INCLUDED