/*******************************************************************************
 *  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.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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;


/**
 * A sequence of one or more Items that provide the position of RF excitations used to select a volume of tissue.
 */
public class VolumeLocalizationSequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	VolumeLocalizationSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	VolumeLocalizationSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in VolumeLocalizationSequenceItem  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,0x9104))
				throw new MandatoryMissingException("0018,9104");
			if(!contains(0x0018,0x9105)) 
				throw new MandatoryMissingException("0018,9105");
			if(!contains(0x0018,0x9106))
				throw new MandatoryMissingException("0018,9106");
			/*
			 * Condition for Referenced Image Sequence are not clear
			 * condition :- Required if a sequence item is present,and if graphic annotations in this Item do
			 * not apply to all the images listed in the Presentation State Module.
			 * Refer p.d.f Chapter 3
			 * Page No :- 690
			 */
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets thickness of slab in mm.
	 * @param dblSlabThickness thickness of slab in mm.
	 */
	public void setSlabThickness(double dblSlabThickness)
	{
		/*Accept the Physical Delta X 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,0x9104, dblSlabThickness,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9104,DicomConstants.DCM_DT_FD, dblSlabThickness);

		addDataElement(objIDataElement);


	}

	/**
	 * Retrieves thickness of slab in mm.
	 * @return double - double value of thickness of slab in mm.
	 */
	public double getSlabThickness()
	{
		Object objValue = getValue(0x0018,0x9104);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets direction cosines of a normal vector perpendicular to the selection plane with respect to the patient.
	 * @param arrdblSlabOrientation array of double values for Slab Orientation
	 */
	public void setSlabOrientation(double []arrdblSlabOrientation)
	{
		/*Accept the Value Type in String 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,0x9105, arrdblSlabOrientation,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9105,DicomConstants.DCM_DT_FD, arrdblSlabOrientation);

		addDataElement(objIDataElement);

	}

	/**
	 * Retrieves cosines of a normal vector perpendicular to the selection plane with respect to the patient.
	 * @return double[] - double values of cosines in normal vector
	 */
	public double[] getSlabOrientation()
	{
		Object objValue = getValue(0x0018,0x9105);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}


	/**
	 * Sets the x, y, and z coordinates of the midpoint of the slab in mm.
	 * @param arrdblMidSlabPosition  array of double values coordinates
	 */
	public void setMidSlabPosition(double []arrdblMidSlabPosition)
	{
		/*Accept the Value Type in String 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,0x9106, arrdblMidSlabPosition,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9106,DicomConstants.DCM_DT_FD, arrdblMidSlabPosition);

		addDataElement(objIDataElement);


	}

	/**
	 * Retrieves the x, y, and z coordinates of the midpoint of the slab in mm.
	 * @return double[] - array of double values coordinates
	 */
	public double[] setMidSlabPosition()
	{
		Object objValue = getValue(0x0018,0x9106);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
}
