#ifndef INDIVIDUALOBJECTIVEFOCUSING_HPP_INCLUDED
#define INDIVIDUALOBJECTIVEFOCUSING_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/FocusingDevice_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 IndividualObjectiveFocusing.
*
* A Focusing mechanism is used to obtain maximum sharpness in an Image by changing the distance between a Sample and the optical system forming the Image. In most cases, a Z-axis Focusing mechanism moves the Objective along the optical axis. This element describes an optional objective nano-Focusing Device associated with this Instrument. These devices might be driven using piezoelectric mechanisms or linear motor actuators associated with crossed roller guideways. They typically achieve higher precision, accuracy, and speed than traditional Focusing Devices.
*/
class NBO_EXPORT IndividualObjectiveFocusing : public FocusingDevice_Type {

public:
	
	IndividualObjectiveFocusing();
	~IndividualObjectiveFocusing();

	/*!
	* \brief Cast a NBOBaseClass to a IndividualObjectiveFocusing.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<IndividualObjectiveFocusing> 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 PiezoElectric attribute.
	*
	* This field describes whether this device is Piezoelectric driven (True) or not (False).
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setPiezoElectric(const bool& value, bool validate = true);

	/*!
	* \brief Returns the value of the PiezoElectric attribute.
	*
	* This field describes whether this device is Piezoelectric driven (True) or not (False).
	*
	* \return The value of the attribute
	*/
	bool getPiezoElectric() const;

	/*!
	* \brief Resets the PiezoElectric attribute to an unset state.
	*
	* This field describes whether this device is Piezoelectric driven (True) or not (False).
	*/
	void resetPiezoElectric();

	/*!
	* \brief Checks whether the PiezoElectric attribute is present.
	*
	* This field describes whether this device is Piezoelectric driven (True) or not (False).
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasPiezoElectric() const;


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

    std::optional<bool> PiezoElectric; // Required attribute
};

/*! Shared pointer for IndividualObjectiveFocusing*/
typedef std::shared_ptr<IndividualObjectiveFocusing> IndividualObjectiveFocusingPtr;

} // namespace Inscoper::NBO

#endif // INDIVIDUALOBJECTIVEFOCUSING_HPP_INCLUDED