/*******************************************************************************
 *  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 the methods to set, get and validate the attribute present in Lateral Spreading Device Settings Sequence .
 */

public class LateralSpreadingDeviceSettingsSequenceItem  extends Item
{

	private static final long serialVersionUID = 1L;


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

	/**
	 * This constructor creates Range Shifter Sequence Item with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used .
	 */
	LateralSpreadingDeviceSettingsSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in RangeShifterSettingsSequenceItem according the rules defined by the Lateral Spreading Device Settings Sequence Item.
	 * @return boolean - Success -true, Failure - false.
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule() throws InvalidItemException
	{
		try
		{
			if(!contains(0x300C,0x0102))
				throw new MandatoryMissingException("300C,0102") ;
			if(!contains(0x300A,0x0372))
				throw new MandatoryMissingException("300A,0372");
			
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	/**
	 * Sets Referenced Lateral Spreading Device Number.
	 * Uniquely identifies lateral spreading device specified by Lateral Spreading Device Number (300A,0334) 
	 * within Beam referenced by Referenced Beam Number (300C,0006).
	 * @param strReferencedLateralSpreadingDeviceNumber String value of Referenced Lateral Spreading Device Number.
	 */
	public void setReferencedLateralSpreadingDeviceNumber(String strReferencedLateralSpreadingDeviceNumber )
	{
		/*Accept the ReferencedLateralSpreadingDeviceNumber  in String format of type IS.
		 * 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(0x300C,0x0102, strReferencedLateralSpreadingDeviceNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0102,DicomConstants.DCM_DT_IS, strReferencedLateralSpreadingDeviceNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves ReferencedLateralSpreadingDeviceNumber. 
	 * Uniquely identifies lateral spreading device specified by Lateral Spreading Device Number (300A,0334) 
	 * within Beam referenced by Referenced Beam Number (300C,0006).
	 * @return String - value of Referenced Lateral Spreading Device Number .
	 */
	public String getReferencedLateralSpreadingDeviceNumber()
	{
		Object objValue = getValue(0x300C,0x0102);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the LateralSpreadingDeviceSettingsSequence.
	 * @param fLateralSpreadingDeviceSettingsSequence Float value of the Lateral Spreading Device Settings Sequence.
	 */
	public void setLateralSpreadingDeviceSettingsSequence( float fLateralSpreadingDeviceSettingsSequence)
	{
		/*
		 * Accept the LateralSpreadingDeviceSettingsSequence in String format of type FL.
		 * 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(0x300A,0x0372, fLateralSpreadingDeviceSettingsSequence,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0372,DicomConstants.DCM_DT_FL, fLateralSpreadingDeviceSettingsSequence);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Lateral Spreading Device Settings Sequence.
	 * @return float - Float value of the Ratio of LateralSpreadingDeviceSettingsSequence.
	 */
	public float getLateralSpreadingDeviceSettingsSequence()
	{
		Object objValue = getValue(0x300A,0x0372);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets LateralSpreadingDeviceSetting.
	 * @param strLateralSpreadingDeviceSetting String value of Lateral Spreading Device Setting.
	 */
	public void setLateralSpreadingDeviceSetting(String strLateralSpreadingDeviceSetting)
	{
		/* Accept the LateralSpreadingDeviceSetting in String format of type LO.
		 * 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(0x300A,0x0374, strLateralSpreadingDeviceSetting,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0374,DicomConstants.DCM_DT_LO, strLateralSpreadingDeviceSetting);

		addDataElement(objIDataElement);
	}

	/**
	 * Return user-defined label identifier for LateralSpreadingDeviceSetting.
	 * @return String - value of LateralSpreadingDeviceSetting.
	 */
	public String getLateralSpreadingDeviceSetting()
	{
		Object objValue = getValue(0x300A,0x0374);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the LateralS preadingD evice Water Equivalent Thickness.
	 * @param fLateralSpreadingDeviceWaterEquivalentThickness Float value of the Lateral Spreading Device Water Equivalent Thickness
	 */
	public void setLateralSpreadingDeviceWaterEquivalentThickness( float fLateralSpreadingDeviceWaterEquivalentThickness)
	{
		/*
		 * Accept the LateralSpreadingDeviceWaterEquivalentThickness in String format of type FL.
		 * 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(0x300A,0x033C, fLateralSpreadingDeviceWaterEquivalentThickness,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x033C,DicomConstants.DCM_DT_FL, fLateralSpreadingDeviceWaterEquivalentThickness);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the LateralSpreadingDeviceWaterEquivalentThickness.
	 * @return float - Float value of the LateralSpreadingDeviceWaterEquivalentThickness
	 */
	public float getLateralSpreadingDeviceWaterEquivalentThickness()
	{
		Object objValue = getValue(0x300A,0x033C);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
