/*******************************************************************************
 *  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.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumDiffusionDirectionality;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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;

import  cdac.medinfo.sdk.dcm30_04.enums.EnumDiffusionAnisotropyType;
/**
* This item class contains methods to validate, set and get attributes in {@link MRDiffusionSequence}. 
*/
public class MRDiffusionSequenceItem extends Item
{
	

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

	/**
	 * This constructor creates the item and internal MR Echo Macro with default TransferSyntax 
	 */
	MRDiffusionSequenceItem()
	{
		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 and internal MR Echo Macro with specified TS
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax 
	 */
	MRDiffusionSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates the item and internal MR Echo Macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	MRDiffusionSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in CodeSequenceMacro 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
		{
			/*
			 *  Since this class is implemented while implementing MACRO, Validations required for modules
			 *  is not cleared that is modules using this item is not known now.
			 *  Validation conditions for attributes of these Item is not cleared.  
			 *  Refer p.d.f Chapter 3
			 *  Page No :- 618
			 */
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		catch( InvalidMacroException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ime.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ime);
		}
		return true;
	}
	
	/**
	 * Sets the Diffusion sensitization factor in sec/mm2. This is the actual b-value for original
	 * frames and those derived from frames with the same b-value, or the most representative b-value when 
	 * derived from images with different b-values.
	 * @param dblDiffusionbvalue String array of coordinates
	 */
	public void setDiffusionbvalue(double dblDiffusionbvalue)
	{
		/*Accept the Diffusion b-value 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,0x9087, dblDiffusionbvalue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9087,DicomConstants.DCM_DT_FD, dblDiffusionbvalue);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Diffusion sensitization factor in sec/mm2. This is the actual b-value for original
	 * frames and those derived from frames with the same b-value, or the most representative b-value when 
	 * derived from images with different b-values.
	 * @return double - double value of Diffusionbvalue
	 */
	public double getDiffusionbvalue()
	{
		Object objValue = getValue(0x0018,0x9087);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Specifies whether diffusion conditions for the frame are directional, or isotropic with respect to direction.
	 * @param enumShapeType Enum value for geometric interpretation of the Contour Data
	 */
	public void setDiffusionDirectionality(EnumDiffusionDirectionality enumDiffusionDirectionality)
	{
		/*Accept the Diffusion Directionality 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,0x9075, enumDiffusionDirectionality.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9075,DicomConstants.DCM_DT_CS, enumDiffusionDirectionality.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Specifies whether diffusion conditions for the frame are directional, or isotropic with respect to direction.
	 * @return String - value for DiffusionDirectionality
	 */
	public String getDiffusionDirectionality()
	{
		Object objValue = getValue(0x0018,0x9075);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of Diffusion Gradient Direction 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.
	 * @return objDiffusionGradientDirectionSequence - instance of Diffusion Gradient Direction Sequence. 
	 */
	public DiffusionGradientDirectionSequence getDiffusionGradientDirectionSequence()
	{
		DiffusionGradientDirectionSequence objDiffusionGradientDirectionSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0018,0x9076);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objDiffusionGradientDirectionSequence = (DiffusionGradientDirectionSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objDiffusionGradientDirectionSequence = (DiffusionGradientDirectionSequence)objDicomV3Factory.createSequence(0x0018,0x9076, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0018,0x9076, objDiffusionGradientDirectionSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0018,0x9076, DicomConstants.DCM_DT_SQ, objDiffusionGradientDirectionSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objDiffusionGradientDirectionSequence;
	}
	
	/**
	 * Sets Class of diffusion anisotropy calculation.
	 * @param enumShapeType Enum value for geometric interpretation of the Contour Data
	 */
	public void setDiffusionAnisotropyType(EnumDiffusionAnisotropyType enumDiffusionAnisotropyType)
	{
		/*Accept the Diffusion Anisotropy 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,0x9147, enumDiffusionAnisotropyType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9147,DicomConstants.DCM_DT_CS, enumDiffusionAnisotropyType.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Class of diffusion anisotropy calculation.
	 * @return String - value for DiffusionAnisotropyType
	 */
	public String getDiffusionAnisotropyType()
	{
		Object objValue = getValue(0x0018,0x9147);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
