#ifndef PLANETRANSFORMATIONMATRIX_HPP_INCLUDED
#define PLANETRANSFORMATIONMATRIX_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/LSID_Type.h>
#include <NBO/NBO/rowType_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 PlaneTransformationMatrix.
*
* This element describes a 4x4 matrix relating the position of this Plane typically with respect to other Planes within this Image or collection of Images (or alternatively to the Microscope's reference frame). This can correct for translations, rotations, scale differences, or other affine distortions between Planes from the same set or between Image Datasets. An example is when multiple cameras are used for e.g. to acquire different Channels for the same Image. See: https://www.openmicroscopy.org/community/viewtopic.php?p=17433.
*/
class NBO_EXPORT PlaneTransformationMatrix : public NBOBaseClass {

public:
	
	PlaneTransformationMatrix();
	~PlaneTransformationMatrix();

	/*!
	* \brief Cast a NBOBaseClass to a PlaneTransformationMatrix.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<PlaneTransformationMatrix> 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 list of Row elements.
	*
	* No description available in the XSD standard.
	*
	* \param value The new list of Row elements
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setRow_List(const std::vector<Inscoper::NBO::rowType_TypePtr>& value, bool validate = true);

	/*!
	* \brief Returns the list of Row elements.
	*
	* No description available in the XSD standard.
	*
	* \return The list of Row elements
	*/
	std::vector<Inscoper::NBO::rowType_TypePtr> getRow_List() const;

	/*!
	* \brief Adds a new Row element to this object.
	*
	* No description available in the XSD standard.
	*
	* \param value The element to add
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void addToRow_List(const Inscoper::NBO::rowType_TypePtr& value, bool validate = true);

	/*!
	* \brief Clear the list of Row.
	*
	* No description available in the XSD standard.
	*/
	void clearRow_List();


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

	LSID_TypePtr ID = nullptr; // Required attribute
    std::vector<Inscoper::NBO::rowType_TypePtr> Row_List;
};

/*! Shared pointer for PlaneTransformationMatrix*/
typedef std::shared_ptr<PlaneTransformationMatrix> PlaneTransformationMatrixPtr;

} // namespace Inscoper::NBO

#endif // PLANETRANSFORMATIONMATRIX_HPP_INCLUDED