/*******************************************************************************
 *  Copyright 2017-2018 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *  
 *   http://www.apache.org/licenses/LICENSE-2.0
 *  
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package cdac.medinfo.sdk.dcm30_04.baselibs;

import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataElement;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;

/**
 * This class contains a Macro that contains definition of landmarks that can be used during planning to align an implant template with patient geometry.
 * @author saloni
 *
 */
public class PlanningLandmarkPlaneMacro extends Macro   
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor constructs a Macro with specified DataSet.
	 * @param objDataSet Collection of DataElements 
	 */
	public PlanningLandmarkPlaneMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

	/**
	 * This constructor constructs a Macro with specified DataSet and DictionaryReader
	 * @param objDataSet specifies the DataSet
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public PlanningLandmarkPlaneMacro(IDataSet objDataSet,IDictionaryReader objDictionaryReader)
	{
		super(objDataSet,objDictionaryReader);
	}

	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public PlanningLandmarkPlaneMacro(IItem objItem)
	{
		super(objItem);
	}

	/**
	 * This constructor constructs a Macro with the specified Item and DictionaryReader
	 * @param objItem specifies instance of Item class
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public PlanningLandmarkPlaneMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}

	/**
	 * Validates all the attributes in PlanningLandmarkPlaneMacro
	 * @return boolean - Success -true, Failure -false.
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate() throws InvalidMacroException
	{
		if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
			return validate(objIDataSet);
		else if(iMacroLevel == DicomConstants.DCM_ITEM_LEVEL_MACRO)
			return validate(objIItem);
		return false;
	}

	/**
	 * Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet
	 * @param objIDataSet collection of DataElements
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IDataSet objIDataSet) throws InvalidMacroException
	{
		try
		{ 

			//validate condition here
			
			if(!objIDataSet.isPresent(0x0068,0x6610) && objIDataSet.isPresent(0x0068,0x62C0))
				if(!objIDataSet.isPresent(0x0068,0x65E0))
					throw new ConditionFailedException("0x0068,0x65E0");
			if(!objIDataSet.isPresent(0x0068,0x65E0) && objIDataSet.isPresent(0x0068,0x6350))
				if(!objIDataSet.isPresent(0x0068,0x6610))
					throw new ConditionFailedException("0x0068,0x6610");
			if(objIDataSet.isPresent(0x0068,0x6610))
				if(!objIDataSet.isPresent(0x0068,0x6620))
					throw new ConditionFailedException("0x0068,0x6620");
			
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException( PlanningLandmarkPlaneMacro.class.getSimpleName() ,ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(PlanningLandmarkPlaneMacro.class.getSimpleName() ,me);
		}
		return true;
	}

	/**
	 * Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet
	 * @param objIItem collection of DataElements in a sequence
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IItem objIItem) throws InvalidMacroException
	{
		try
		{  
			//validate condition here
			
			if(!objIItem.contains(0x0068,0x6610) && objIItem.contains(0x0068,0x62C0))
				if(!objIItem.contains(0x0068,0x65E0))
					throw new ConditionFailedException("0x0068,0x65E0");
			if(!objIItem.contains(0x0068,0x65E0) && objIItem.contains(0x0068,0x6350))
				if(!objIItem.contains(0x0068,0x6610))
					throw new ConditionFailedException("0x0068,0x6610");
			if(objIItem.contains(0x0068,0x6610))
				if(!objIItem.contains(0x0068,0x6620))
					throw new ConditionFailedException("0x0068,0x6620");
			
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException(PlanningLandmarkPlaneMacro.class.getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(PlanningLandmarkPlaneMacro.class.getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Retrieves pre-initialized object of 2D Plane Coordinates Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence.
	 * 2D coordinates of the point in the HPGL documents.
	 * @return TwoDPlaneCoordinatesSequence - instance of TwoDPlaneCoordinatesSequence. 
	 */
	public TwoDPlaneCoordinatesSequence getTwoDPlaneCoordinatesSequence()
	{
		TwoDPlaneCoordinatesSequence objTwoDPlaneCoordinatesSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0068, 0x65E0);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objTwoDPlaneCoordinatesSequence = (TwoDPlaneCoordinatesSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objTwoDPlaneCoordinatesSequence = (TwoDPlaneCoordinatesSequence)objDicomV3Factory.createSequence(0x0068, 0x65E0, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0068, 0x65E0, objTwoDPlaneCoordinatesSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0068, 0x65E0, DicomConstants.DCM_DT_SQ, objTwoDPlaneCoordinatesSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objTwoDPlaneCoordinatesSequence;
	}
	
	/**
	 * Sets the 3D Plane Origin.
	 * 3D Coordinates of the plane origin.
	 * @param dblArrThreeDPlaneOrigin Double value of 3D Plane Origin
	 */
	public void setThreeDPlaneOrigin(double[] dblArrThreeDPlaneOrigin)
	{
		/*Accept the 3D Plane Origin in double format of type FD.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0068,0x6610, dblArrThreeDPlaneOrigin,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0068,0x6610,DicomConstants.DCM_DT_FD, dblArrThreeDPlaneOrigin);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the 3D Plane Origin.
	 * 3D Coordinates of the plane origin.
	 * @return double - double value of 3D Plane Origin
	 */
	public double[] getThreeDPlaneOrigin()
	{
		Object objValue = getValue(0x0068,0x6610);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
	
	/**
	 * Sets the 3D Plane Normal.
	 * 3D Coordinates of the plane normal.
	 * @param dblArrThreeDPlaneNormal Double value of 3D Plane Normal
	 */
	public void setThreeDPlaneNormal(double[] dblArrThreeDPlaneNormal)
	{
		/*Accept the 3D Plane Normal in double format of type FD.
		 * Read the Transfer Syntax and check if ImplicitDE or ExplicitDE to create
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0068,0x6620, dblArrThreeDPlaneNormal,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0068,0x6620,DicomConstants.DCM_DT_FD, dblArrThreeDPlaneNormal);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the 3D Plane Normal.
	 * 3D Coordinates of the plane normal.
	 * @return double - double value of 3D Plane Normal
	 */
	public double[] getThreeDPlaneNormal()
	{
		Object objValue = getValue(0x0068,0x6620);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
}
