/*******************************************************************************
 *  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;
/**
* This item class contains methods to validate, set and get the attributes of Two Dimensional to Three Dimensional Map Sequence.
 */

public class TwoDimensionalToThreeDimensionalMapSequenceItem extends Item
{
	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	TwoDimensionalToThreeDimensionalMapSequenceItem()
	{
		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
	 */
	TwoDimensionalToThreeDimensionalMapSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates TwoDimensionalToThreeDimensionalMapSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	TwoDimensionalToThreeDimensionalMapSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	/*
	 * Sets the references one or more frames within this SOP Instance to whichthis sequence item applies. The first frame shall be denoted asframe number one.
	 */
	public void setReferencedFrameNumbers(short[] arrShReferencedFrameNumbers )
	{
		/*Accept the Referenced FrameNumbers in Array of short format of type US.
		 * 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(0x0040, 0xA136, arrShReferencedFrameNumbers,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0040, 0xA136,DicomConstants.DCM_DT_US, arrShReferencedFrameNumbers);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves one or more Referenced FrameNumbers.
	 * @return short Array -  Referenced Frame Numbers
	 */
	public short[] getReferencedFrameNumbers()
	{
		Object objValue = getValue(0x0040, 0xA136);
		if(objValue != null)
			return (short[])objValue;
		return null;
	}
	/**
	 * Sets the number of points in the map. Shall include one or more points.
	 * @param iNumberOfMapPoints int value of NumberOfMapPoints.
	 */
	public void setNumberOfMapPoints(int iNumberOfMapPoints)
	{
		/* Accept the NumberOfMapPoints 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(0x0022,0x1530, iNumberOfMapPoints,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0022,0x1530,DicomConstants.DCM_DT_UL, iNumberOfMapPoints);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the number of points in the map. Shall include one or more points.
	 * @return long - value of NumberOfMapPoints.
	 */
	public int getNumberOfMapPoints()
	{
		Object objValue = getValue(0x0022,0x1530);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/* Sets Two Dimensional to ThreeDimensional Map Data.
	 * @param fTwoDimensionalToThreeDimensionalMapData  float value of Two Dimensional to ThreeDimensional Map Data
	 */
	public void setTwoDimensionalToThreeDimensionalMapData(float fTwoDimensionalToThreeDimensionalMapData)
	{
		/* Accept the Two Dimensional to ThreeDimensional Map Data  of type OF.
		 * 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(0x0022,0x1531,fTwoDimensionalToThreeDimensionalMapData,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0022,0x1531,DicomConstants.DCM_DT_OF, fTwoDimensionalToThreeDimensionalMapData);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Two Dimensional to ThreeDimensional Map Data
	 * @return float - float value of Two Dimensional to ThreeDimensional Map Data
	 */
	public float getTwoDimensionalToThreeDimensionalMapData()
	{
		Object objValue = getValue(0x0022,0x1531);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Validates all the attributes in TwoDimensionalToThreeDimensionalMapSequenceItem that are present in the DataSet
	 * @return int - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */

	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			
			if(!contains(0x0040,0xA136))
				throw new MandatoryMissingException("0040,A136");			
			if(!contains(0x0022,0x1530))
				throw new MandatoryMissingException("0022,1530");
			if(!contains(0x0022,0x1531))
				throw new MandatoryMissingException("0022,1531");
					
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
