/*******************************************************************************
 *  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 methods to validate, set and get the attributes of Relevant OPT Attributes Sequence.
 */

public class RelevantOPTAttributesSequenceItem extends Item{

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	RelevantOPTAttributesSequenceItem()
	{
		super();
	}


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

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

	/**
	 * Sets the Depth Spatial Resolution.
	 * @param fDepthSpatialResolution Float value of the Ratio of displayed pixels to source pixels
	 */
	public void setDepthSpatialResolution( float fDepthSpatialResolution)
	{
		/*
		 * Accept the DepthSpatialResolution in String format of type FL.
		 * The inherent limiting resolution in microns for depth of the acquisition equipment for high contrast 
		 * objects for the data gathering and reconstruction technique chosen. If variable, the value at the center of the scanning volume.
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0022,0x0035, fDepthSpatialResolution,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0022,0x0035,DicomConstants.DCM_DT_FL, fDepthSpatialResolution);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Ratio of displayed pixels to source pixels,specified in one dimension.
	 * @return float - Float value of the Depth Spatial Resolution
	 */
	public float getDepthSpatialResolution()
	{
		Object objValue = getValue(0x0022,0x0035);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the Maximum Depth Distortion.
	 * @param fMaximumDepthDistortion Float value of the Ratio of displayed pixels to source pixels
	 */
	public void setMaximumDepthDistortion( float fMaximumDepthDistortion)
	{
		/*
		 * Accept the MaximumDepthDistortion in String format of type FL.
		 * Maximum distortion in depth direction in % of Depth Spatial Resolution.
		 * Add this element to the Data Set
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x0022,0x0036, fMaximumDepthDistortion,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0022,0x0036,DicomConstants.DCM_DT_FL, fMaximumDepthDistortion);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Maximum Depth Distortion.Maximum distortion in depth direction in % of Depth Spatial Resolution.
	 * @return float - Float value of the Depth Spatial Resolution
	 */
	public float getMaximumDepthDistortion()
	{
		Object objValue = getValue(0x0022,0x0036);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

        /**
	 * Validates all the attributes in RelevantOPTAttributesSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0022,0x0035))
				throw new MandatoryMissingException("0022,0035") ;
			if(!contains(0x0022,0x0036))
				throw new MandatoryMissingException("0022,0036") ;
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

}
