/*******************************************************************************
 *  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.EnumLUTFunction;
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;
/**
* This item class contains the methods to set, get and validate the attribute present in Pixel Intensity Relationship LUT Sequence .
 */


public class PixelIntensityRelationshipLUTSequenceItem extends Item
{
	


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


	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	PixelIntensityRelationshipLUTSequenceItem()
	{
		super();
	}
	
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 */
	PixelIntensityRelationshipLUTSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates Pixel Intensity Relationship LUT Sequence Item with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used .
	 */
	PixelIntensityRelationshipLUTSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in PixelIntensityRelationshipLUTSequenceItem according the rules defined by the Range Shifter Sequence Item.
	 * @return boolean - Success -true, Failure - false.
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule() throws InvalidItemException
	{
		try
		{
			if(!contains(0x0028,0x9507))
				throw new MandatoryMissingException("0028,9507");
			if(!contains(0x0028,0x3002))
				throw new MandatoryMissingException("0028,3002");
			if(!contains(0x0028,0x3006))
				throw new MandatoryMissingException("0028,3006");
			if(!contains(0x0028,0x9474))
				throw new MandatoryMissingException("0028,9474");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets LUT Frame Range
	 * @param shLUTFrameRange short value of LUT Frame Range
	 */
	public void setLUTFrameRange(short shLUTFrameRange)
	{
		/* Accept the LUTFrameRange 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(0x0028,0x9507,shLUTFrameRange,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x9507,DicomConstants.DCM_DT_US, shLUTFrameRange);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves LUT Frame Range
	 * @return short - short value of LUT Frame Range
	 */
	public short getLUTFrameRange()
	{
		Object objValue = getValue(0x0028,0x9507);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets LUT Descriptor
	 * @param arrShLUTDescriptor - Value of LUT Descriptor
	 */
	public void setLUTDescriptor(short[] arrShLUTDescriptor)
	{
		/*Accept the LUT Descriptor in Array of short format 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(0x0028,0x3002, arrShLUTDescriptor,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x3002,DicomConstants.DCM_DT_US, arrShLUTDescriptor);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves LUT Descriptor.
	 * @return short Array - LUT Descriptor.
	 */
	public short[] getLUTDescriptor()
	{
		Object objValue = getValue(0x0028,0x3002);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}

	/**
	 * Sets LUT Data in this Sequence.
	 * @param sLUTData short array of LUT Data.
	 */
	public void setLUTData(short[] sLUTData)
	{
		/* Accept the LUT Data in short Array format of type US  or OW.
		 * 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(0x0028, 0x3006, sLUTData,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0028, 0x3006,DicomConstants.DCM_DT_US, sLUTData);
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves LUT Data in this Sequence.
	 * @return - short array of LUT Data.
	 */
	public short[] getLUTData()
	{
		Object objValue = getValue(0x0028, 0x3006);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}
	/**
	 * The transformation function this LUT applies to the stored pixel values.
	 *Defined Terms:
	 *TO_LOG
	 *TO_LINEAR
	 * @param enumLUTFunction enum value of LUT Function.
	 */
	public void setLUTFunction(EnumLUTFunction enumLUTFunction)
	{
		/* Accept the LUTFunction 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(0x0028,0x9474, enumLUTFunction.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x9474,DicomConstants.DCM_DT_CS, enumLUTFunction.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of LUT Function. 
	 * @return String - value of LUT Function.
	 */
	public String getLUTFunction()
	{
		Object objValue = getValue(0x0028,0x9474);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	
}
