/*******************************************************************************
 *  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.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 ASL Slab Sequence .
 */


public class ASLSlabSequenceItem extends GeneralAnatomyOptionalMacroDependentItem
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax .
	 */
	ASLSlabSequenceItem()
	{
		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
	 */
	ASLSlabSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates ASLSlabSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used.
	 */
	ASLSlabSequenceItem(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 ASLSlabSequenceItem 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,0x9253))
				throw new MandatoryMissingException("0018,9253");
			if(!contains(0x0018,0x9254))
				throw new MandatoryMissingException("0018,9254");
			if(!contains(0x0018,0x9255))
				throw new MandatoryMissingException("0018,9255");
			if(!contains(0x0018,0x9256))
				throw new MandatoryMissingException("0018,9256");
			if(!contains(0x0018,0x9258))
				throw new MandatoryMissingException("0018,9258");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets ASL Slab Number.
	 * @param shASLSlabNumber -short value of ASL Slab Number.
	 */
	public void setASLSlabNumber(short shASLSlabNumber)
	{
		/* Accept the ASL Slab Number 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,0x9253,shASLSlabNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9253,DicomConstants.DCM_DT_US, shASLSlabNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves ASL Slab Number.
	 * @return short - short value of ASL Slab Number.
	 */
	public short getASLSlabNumber()
	{
		Object objValue = getValue(0x0018,0x9253);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets ASL Slab Thickness.
	 * Thickness of slab in mm.
	 * @param shASLSlabThickness- short value of ASL Slab Thickness.
	 */
	public void setASLSlabThickness(short shASLSlabThickness)
	{
		/* Accept the ASL Slab Thickness 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,0x9254,shASLSlabThickness,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9254,DicomConstants.DCM_DT_US, shASLSlabThickness);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves ASL Slab Thickness.
	 * Thickness of slab in mm.
	 * @return short - short value of ASL Slab Thickness.
	 */
	public short getASLSlabThickness()
	{
		Object objValue = getValue(0x0018,0x9254);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the ASL Slab Orientation.
	 * The direction cosines of a normal vector perpendicular to the ASL slab with respect to the patient.
	 * @param dblArrASLSlabOrientation -Double value of ASL Slab Orientation
	 */
	public void setASLSlabOrientation(double[] dblArrASLSlabOrientation)
	{
		/*Accept the ASL Slab Orientation 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,0x9255, dblArrASLSlabOrientation,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9255,DicomConstants.DCM_DT_FD, dblArrASLSlabOrientation);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the ASL Slab Orientation.
	 * The direction cosines of a normal vector perpendicular to the ASL slab with respect to the patient.
	 * @return double - double value of ASL Slab Orientation
	 */
	public double[] getASLSlabOrientation()
	{
		Object objValue = getValue(0x0018,0x9255);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
	
	/**
	 * Sets the ASL Mid Slab Position.
	 * The x, y, and z coordinates of the midpoint of the slab in mm with respect to the patient.
	 * @param dblArrASLMidSlabPosition -Double value of ASL Mid Slab Position
	 */
	public void setASLMidSlabPosition(double[] dblArrASLMidSlabPosition)
	{
		/*Accept the ASL Mid Slab Position 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,0x9256, dblArrASLMidSlabPosition,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9256,DicomConstants.DCM_DT_FD, dblArrASLMidSlabPosition);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the ASL Mid Slab Position.
	 * The x, y, and z coordinates of the midpoint of the slab in mm with respect to the patient.
	 * @return double - double value of ASL Mid Slab Position
	 */
	public double[] getASLMidSlabPosition()
	{
		Object objValue = getValue(0x0018,0x9256);
		if(objValue != null)
			return (double[])objValue;
		return null;
	}
	
	/**
	 * Sets ASL Pulse Train Duration.
	 * Duration (in milliseconds) of the Label or Control pulse.
	 * @param iASLPulseTrainDuration- int value of ASL Pulse Train Duration.
	 */
	public void setASLPulseTrainDuration(int iASLPulseTrainDuration)
	{
		/* Accept the ASL Pulse Train Duration of type UL.
		 * 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,0x9258, iASLPulseTrainDuration,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9258,DicomConstants.DCM_DT_UL, iASLPulseTrainDuration);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves ASL Pulse Train Duration.
	 * Duration (in milliseconds) of the Label or Control pulse.
	 * @return long - value of ASL Pulse Train Duration.
	 */
	public int getASLPulseTrainDuration()
	{
		Object objValue = getValue(0x0018,0x9258);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}


}
