/*******************************************************************************
 *  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 attributes in Chemical Shift Sequence. 
*/
public class ChemicalShiftSequenceItem extends Item
{
	

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

	/**
	 * This constructor creates the item and internal Chemical Shift Sequence with default TransferSyntax 
	 */
	ChemicalShiftSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item and internal Chemical Shift Sequence with specified TS
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax 
	 */
	ChemicalShiftSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates the item and internal Chemical Shift Sequence with default TransferSyntax 
	 * and default DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	ChemicalShiftSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in Chemical Shift Sequence that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x0018,0x9295))
				throw new MandatoryMissingException("0018,9295");
			if(!contains(0x0018,0x9296))
				throw new MandatoryMissingException("0018,9296");

		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets the Minimal value of Chemical Shift Frequency in ppm.
	 * @param dblChemicalShiftsMinimumIntegrationLimitOnppm -double value of Chemical Shift Frequency.
	 */
	public void setChemicalShiftsMinimumIntegrationLimitOnppm(double dblChemicalShiftsMinimumIntegrationLimitOnppm)
	{
		/*Accept the Chemical Shifts Minimum Integration Limit in ppm 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,0x9295, dblChemicalShiftsMinimumIntegrationLimitOnppm,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9295,DicomConstants.DCM_DT_FD, dblChemicalShiftsMinimumIntegrationLimitOnppm);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Minimal value of Chemical Shift Frequency in ppm.
	 * @return double - double value of ChemicalShiftsMinimumIntegrationLimitOnppm
	 */
	public double getChemicalShiftsMinimumIntegrationLimitOnppm()
	{
		Object objValue = getValue(0x0018,0x9295);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the Maximum value of Chemical Shift Frequency in ppm.
	 * @param dblChemicalShiftsMaximumIntegrationLimitOnppm  double value of Chemical Shift Frequency .
	 */
	public void setChemicalShiftsMaximumIntegrationLimitOnppm(double dblChemicalShiftsMaximumIntegrationLimitOnppm)
	{
		/*Accept the Chemical Shifts Maximum Integration Limit in ppm 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,0x9296, dblChemicalShiftsMaximumIntegrationLimitOnppm,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9296,DicomConstants.DCM_DT_FD, dblChemicalShiftsMaximumIntegrationLimitOnppm);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Maximum value of Chemical Shift Frequency in ppm.
	 * @return double - double value of ChemicalShiftsMaximumIntegrationLimitOnppm
	 */
	public double getChemicalShiftsMaximumIntegrationLimitOnppm()
	{
		Object objValue = getValue(0x0018,0x9296);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
