/*******************************************************************************
 *  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.utils.DicomConstants;




/**
 * This Item class provides methods to set,get and validate the attributes in {@link EnergyWindowRangeSequence}.
 */
public class EnergyWindowRangeSequenceItem extends Item  
{
	

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

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

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

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

	/**
	 * Validates all the attributes in EnergyWindowRangeSequenceItem 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
	{
		/*
		 * All fields in this sequence are optional
		 */
		return true;
	}

	/**
	 * Sets the lower limit of the energy window, in KeV.
	 * @param strEnergyWindowLowerLimit String value of Energy Window Lower Limit.
	 */
	public void setEnergyWindowLowerLimit(String strEnergyWindowLowerLimit)
	{
		/*Accept the EnergyWindowLowerLimit in String format of type DS.
		 * 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(0x0054, 0x0014, strEnergyWindowLowerLimit,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0054, 0x0014,DicomConstants.DCM_DT_DS, strEnergyWindowLowerLimit);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the lower limit of the energy window, in KeV.
	 * @return String - value of Energy Window Lower Limit.
	 */
	public String getEnergyWindowLowerLimit()
	{
		Object objValue = getValue(0x0054, 0x0014);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets the upper limit of the energy window, in KeV.
	 * @param strEnergyWindowUpperLimit String value of Energy Window Upper Limit.
	 */
	public void setEnergyWindowUpperLimit(String strEnergyWindowUpperLimit)
	{
		/*Accept the EnergyWindowUpperLimit in String format of type DS.
		 * 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(0x0054, 0x0015, strEnergyWindowUpperLimit,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0054, 0x0015,DicomConstants.DCM_DT_DS, strEnergyWindowUpperLimit);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves the upper limit of the energy window, in KeV.
	 * @return String - value of Energy Window Upper Limit.
	 */
	public String getEnergyWindowUpperLimit()
	{
		Object objValue = getValue(0x0054, 0x0015);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
