/*******************************************************************************
 *  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.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 Frame Pixel Shift Sequence.
 */
public class FramePixelShiftSequenceItem extends Item
{


	private static final long serialVersionUID = 1L;


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

	/**
	 * This constructor creates Frame Pixel Shift 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 .
	 */
	FramePixelShiftSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in FramePixelShiftSequenceItem according the rules defined by the Frame Pixel Shift 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,0x9416))
				throw new MandatoryMissingException("0028,9416");
			if(!contains(0x0028,0x6114))
				throw new MandatoryMissingException("0028,6114");
			
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets Subtraction ItemID
	 * @param shLUTFrameRange short value of Number of significant bits
	 */
	public void setSubtractionItemID(short shSubtractionItemID)
	{
		/* Accept the SubtractionItemID 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,0x9416,shSubtractionItemID,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x9416,DicomConstants.DCM_DT_US, shSubtractionItemID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Subtraction ItemID
	 * @return short - short value of Number of significant bits
	 */
	public short getSubtractionItemID()
	{
		Object objValue = getValue(0x0028,0x9416);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets a pair of floating point numbers specifying the fractional vertical [adjacent row spacing] 
	 * and horizontal [adjacent column spacing] pixel shift applied to the mask before subtracting
	 * it from the contrast frame.
	 * @param arrFMaskSubPixelShift pair of floating point numbers
	 */
	public void setMaskSubPixelShift(float[] arrFMaskSubPixelShift)
	{
		/* Accept the Mask Sub-pixel Shift in short format of type FL.
		 * 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,0x6114, arrFMaskSubPixelShift,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0028,0x6114,DicomConstants.DCM_DT_FL, arrFMaskSubPixelShift);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Mask Sub Pixel Shift.
	 * @return float[] - Float array of Mask Sub Pixel Shift.
	 */
	public float[] getMaskSubPixelShift()
	{
		Object objValue = getValue(0x0028,0x6114);
		if(objValue != null)
			return (float[])objValue;
		return null;
	}


}
