/*******************************************************************************
 *  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;

import  cdac.medinfo.sdk.dcm30_04.enums.EnumSpecificAbsorptionRateDefinition;
/**
* This item class contains methods to validate, set and get attributes in {@link SpecificAbsorptionRateSequence}. 
*/
public class SpecificAbsorptionRateSequenceItem extends Item
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	SpecificAbsorptionRateSequenceItem()
	{
		super();
	}

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

	/**
	 * This constructor creates SpecificAbsorptionRateSequenceItem with specified TransferSyntax and specified DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	SpecificAbsorptionRateSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in SpecificAbsorptionRateSequenceItem  that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			//validation of mandatory elements
			if(!contains(0x0018,0x9179))
				throw new MandatoryMissingException("0018,9179");
			if(!contains(0x0018,0x9181))
				throw new MandatoryMissingException("0018,9181");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets Specification of the method of SAR calculation as defined in Applicable Safety Standard Description (0018,9174).
	 * @param EnumSpecificAbsorptionRateDefinition Enum value for geometric interpretation of the Contour Data
	 */
	public void setSpecificAbsorptionRateDefinition(EnumSpecificAbsorptionRateDefinition enumSpecificAbsorptionRateDefinition)
	{
		/*Accept the Shape Type 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(0x0018,0x9179, enumSpecificAbsorptionRateDefinition.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9179,DicomConstants.DCM_DT_CS, enumSpecificAbsorptionRateDefinition.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Specification of the method of SAR calculation as defined in Applicable Safety Standard Description (0018,9174).
	 * @return String - value for SpecificAbsorptionRateDefinition
	 */
	public String getSpecificAbsorptionRateDefinition()
	{
		Object objValue = getValue(0x0018,0x9179);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Specific Absorption Rate in W/kg.
	 * @param dblSpecificAbsorptionRateValue String value of Unique identifier for the Study.
	 */
	public void setSpecificAbsorptionRateValue(double dblSpecificAbsorptionRateValue)
	{
		/* Accept the Specific Absorption Rate Value 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,0x9181, dblSpecificAbsorptionRateValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9181,DicomConstants.DCM_DT_FD, dblSpecificAbsorptionRateValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Specific Absorption Rate in W/kg.
	 * @return double - value of Specific Absorption Rate in W/kg.
	 */
	public double getSpecificAbsorptionRateValue()
	{
		Object objValue = getValue(0x0018,0x9181);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
