#ifndef THEADDITIONALDIMENSION_HPP_INCLUDED
#define THEADDITIONALDIMENSION_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/LSID_Type.h>
#include <NBO/NBO/PositiveInt_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 TheAdditionalDimension.
*
* This element refers to each individual Plane of data pertaining to a given Additional Dimension.
*/
class NBO_EXPORT TheAdditionalDimension : public NBOBaseClass {

public:
	
	TheAdditionalDimension();
	~TheAdditionalDimension();

	/*!
	* \brief Cast a NBOBaseClass to a TheAdditionalDimension.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<TheAdditionalDimension> 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 TheAdditionalDimensionIndex attribute.
	*
	* This field records the Index of this specific Plane within a vector of Additional Dimension data.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setTheAdditionalDimensionIndex(const Inscoper::NBO::PositiveInt_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the TheAdditionalDimensionIndex attribute.
	*
	* This field records the Index of this specific Plane within a vector of Additional Dimension data.
	*
	* \return The value of the attribute
	*/
	PositiveInt_TypePtr getTheAdditionalDimensionIndex() const;

	/*!
	* \brief Resets the TheAdditionalDimensionIndex attribute to an unset state.
	*
	* This field records the Index of this specific Plane within a vector of Additional Dimension data.
	*/
	void resetTheAdditionalDimensionIndex();

	/*!
	* \brief Checks whether the optional TheAdditionalDimensionIndex attribute is present.
	*
	* This field records the Index of this specific Plane within a vector of Additional Dimension data.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasTheAdditionalDimensionIndex() const;

	/*!
	* \brief Sets the value of the TheIncrementStamp attribute.
	*
	* This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setTheIncrementStamp(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the TheIncrementStamp attribute.
	*
	* This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
	*
	* \return The value of the attribute
	*/
	float getTheIncrementStamp() const;

	/*!
	* \brief Resets the TheIncrementStamp attribute to an unset state.
	*
	* This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
	*/
	void resetTheIncrementStamp();

	/*!
	* \brief Checks whether the TheIncrementStamp attribute is present.
	*
	* This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasTheIncrementStamp() const;


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

	LSID_TypePtr ID = nullptr; // Required attribute
	PositiveInt_TypePtr TheAdditionalDimensionIndex = nullptr; // Required attribute
    std::optional<float> TheIncrementStamp; // Optional attribute
};

/*! Shared pointer for TheAdditionalDimension*/
typedef std::shared_ptr<TheAdditionalDimension> TheAdditionalDimensionPtr;

} // namespace Inscoper::NBO

#endif // THEADDITIONALDIMENSION_HPP_INCLUDED