/*******************************************************************************
 *  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.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumFrameType;
import cdac.medinfo.sdk.dcm30_04.enums.EnumIterativeReconstructionMethod;
import cdac.medinfo.sdk.dcm30_04.enums.EnumReconstructionAlgorithm;
import cdac.medinfo.sdk.dcm30_04.enums.EnumReconstructionType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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 item class contains the methods to set, get and validate the attribute present in PET Reconstruction Sequence.
 */

public class PETReconstructionSequenceItem extends Item
{
	


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

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	PETReconstructionSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	PETReconstructionSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates PETReconstructionSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	PETReconstructionSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in PETReconstructionSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try{
			if(!contains(0x0018,0x9769))
				throw new MandatoryMissingException("0018,9769");
			if(getDataForTag(0x0008, 0x9007).getValue().equals(EnumFrameType.Value1.ORIGINAL)){
				if(!contains(0x0018,0x9756))
					throw new ConditionFailedException("0x0018,0x9756");
				if(!contains(0x0018,0x9315))
					throw new ConditionFailedException("0x0018,0x9315");
				if(!contains(0x0018,0x9756))
					throw new ConditionFailedException("0x0018,0x9756");
				if(getDataForTag(0x0018, 0x9769).getValue().equals(EnumIterativeReconstructionMethod.YES)){
					if(!contains(0x0018,0x9739))
						throw new ConditionFailedException("0x0018,0x9739");
					if(!contains(0x0018,0x9740))
						throw new ConditionFailedException("0x0018,0x9740");
				}
				if(!contains(0x0018, 0x9317))
					if(!contains(0x0018, 0x1100))
						throw new ConditionFailedException("0x0018,0x1100");
				if(!contains(0x0018, 0x1100))
					if(!contains(0x0018, 0x9317))
						throw new ConditionFailedException("0x0018,0x9317");
			}
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets type of Reconstruction.
	 * Defined Terms:
	 * 1) 2D.
	 * 2) 3D.
	 * 3) 3D_REBINNED.
	 * @param enumReconstructionType enum value of Reconstruction Type.
	 */
	public void setReconstructionType(EnumReconstructionType enumReconstructionType)
	{
		/* Accept the Reconstruction Type in String format of type CS.
		 * 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(0x0018,0x9756, enumReconstructionType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9756,DicomConstants.DCM_DT_CS, enumReconstructionType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Reconstruction. 
	 * @return String - value of Reconstruction Type.
	 */
	public String getReconstructionType()
	{
		Object objValue = getValue(0x0018,0x9756);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Reconstruction Algorithm.
	 * Defined Terms:
	 * 1) FILTER_BACK_PROJ.
	 * 2) REPROJECTION.
	 * 3) RAMLA
	 * 4) MLEM.
	 * @param enumReconstructionAlgorithm enum value of Reconstruction Algorithm.
	 */
	public void setReconstructionAlgorithm(EnumReconstructionAlgorithm enumReconstructionAlgorithm)
	{
		/* Accept the Reconstruction Algorithm in String format of type CS.
		 * 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(0x0018,0x9315, enumReconstructionAlgorithm.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9315,DicomConstants.DCM_DT_CS, enumReconstructionAlgorithm.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Reconstruction Algorithm. 
	 * @return String - value of Reconstruction Algorithm.
	 */
	public String getReconstructionAlgorithm()
	{
		Object objValue = getValue(0x0018,0x9315);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets type of Iterative Reconstruction Method.
	 * Iterative Reconstruction Method used.
	 * Defined Terms:
	 * 1) YES.
	 * 2) NO.
	 * @param enumIterativeReconstructionMethod enum value of Iterative Reconstruction Method.
	 */
	public void setIterativeReconstructionMethod(EnumIterativeReconstructionMethod enumIterativeReconstructionMethod)
	{
		/* Accept the Setup Device Type in String format of type CS.
		 * 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(0x0018,0x9769, enumIterativeReconstructionMethod.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9769,DicomConstants.DCM_DT_CS, enumIterativeReconstructionMethod.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Iterative Reconstruction Method. 
	 * Iterative Reconstruction Method used.
	 * @return String - value of Iterative Reconstruction Method.
	 */
	public String getIterativeReconstructionMethod()
	{
		Object objValue = getValue(0x0018,0x9769);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Number of Iterations
	 * @param shNumberofIterations short value of Number of Iterations
	 */
	public void setNumberofIterations(short shNumberofIterations)
	{
		/* Accept the Number of Iterations of type US.
		 * 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(0x0018,0x9739,shNumberofIterations,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9739,DicomConstants.DCM_DT_US, shNumberofIterations);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of Iterations
	 * @return short - short value of Number of Iterations
	 */
	public short getNumberofIterations()
	{
		Object objValue = getValue(0x0018,0x9739);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets Number of Subsets
	 * @param shNumberofSubsets short value of Number of Subsets
	 */
	public void setNumberofSubsets(short shNumberofSubsets)
	{
		/* Accept the Number of Subsets of type US.
		 * 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(0x0018,0x9740,shNumberofSubsets,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9740,DicomConstants.DCM_DT_US, shNumberofSubsets);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of Subsets
	 * @return short - short value of Number of Subsets
	 */
	public short getNumberofSubsets()
	{
		Object objValue = getValue(0x0018,0x9740);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Reconstruction Diameter.
	 * @param strReconstructionDiameter String value of Reconstruction Diameter.
	 */
	public void setReconstructionDiameter(String strReconstructionDiameter)
	{
		/*Accept the Reconstruction Diameter in String format of type DS.
		 * 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(0x0018,0x1100, strReconstructionDiameter,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1100,DicomConstants.DCM_DT_DS, strReconstructionDiameter);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Reconstruction Diameter.
	 * @return String - value of Reconstruction Diameter.
	 */
	public String getReconstructionDiameter()
	{
		Object objValue = getValue(0x0018,0x1100);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Reconstruction Field of View.
	 * @param dblArrReconstructionFieldofView Double value of Reconstruction Field of View
	 */
	public void setReconstructionFieldofView(double[] dblArrReconstructionFieldofView)
	{
		/*Accept the Reconstruction Field of View 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(0x0018,0x9317, dblArrReconstructionFieldofView,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9317,DicomConstants.DCM_DT_FD, dblArrReconstructionFieldofView);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Reconstruction Field of View.
	 * @return double - double value of Reconstruction Field of View
	 */
	public double[] getReconstructionFieldofView()
	{
		Object objValue = getValue(0x0018,0x9317);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
}
