/*******************************************************************************
 *  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 Range Shifter Settings Sequence .
 */

public class RangeShifterSettingsSequenceItem extends Item
{
	


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


	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	RangeShifterSettingsSequenceItem()
	{
		super();
	}
	
	/**
	 * This constructor creates the item with specified TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 */
	RangeShifterSettingsSequenceItem(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 .
	 */
	RangeShifterSettingsSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in RangeShifterSettingsSequenceItem according the rules defined by the Range Shifter 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,0x0100))
				throw new MandatoryMissingException("300C,0100");
			if(!contains(0x300A,0x0362))
				throw new MandatoryMissingException("300A,0362");
			
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets ReferencedRangeShifterNumber. Uniquely references Range Shifter 
	 * described by Range Shifter Number (300A,0316) in Range Shifter Sequence (300A,0314).
	 * @param strReferencedRangeShifterNumber String value of Referenced Range Shifter Number.
	 */
	public void setReferencedRangeShifterNumber (String strReferencedRangeShifterNumber )
	{
		/*Accept the ReferencedRangeShifterNumber  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,0x0100, strReferencedRangeShifterNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0100,DicomConstants.DCM_DT_IS, strReferencedRangeShifterNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves ReferencedRangeShifterNumber. Uniquely references Range Shifter 
	 * described by Range Shifter Number (300A,0316) in Range Shifter Sequence (300A,0314).
	 * @return String - value of Referenced Range Shifter Number.
	 */
	public String getReferencedRangeShifterNumber()
	{
		Object objValue = getValue(0x300C,0x0100);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Range Shifter Setting.
	 * @param strRangeShifterSetting String value of Range Shifter Setting.
	 */
	public void setRangeShifterSetting(String strRangeShifterSetting)
	{
		/* Accept the RangeShifterSetting 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,0x0362, strRangeShifterSetting,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0362,DicomConstants.DCM_DT_LO, strRangeShifterSetting);

		addDataElement(objIDataElement);
	}

	/**
	 * Return user-defined label identifier for Range Shifter Setting.
	 * @return String - value of Range Shifter Setting.
	 */
	public String getRangeShifterSetting()
	{
		Object objValue = getValue(0x300A,0x0362);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	
	/**
	 * Sets the IsocentertoRangeShifterDistance.
	 * @param fIsocentertoRangeShifterDistance Float value of the Isocenter to Range Shifter Distance.
	 */
	public void setIsocentertoRangeShifterDistance( float fIsocentertoRangeShifterDistance)
	{
		/*
		 * Accept the IsocentertoRangeShifterDistance 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,0x0364, fIsocentertoRangeShifterDistance,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0364,DicomConstants.DCM_DT_FL, fIsocentertoRangeShifterDistance);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the IsocentertoRangeShifterDistance.
	 * @return float - Float value of the IsocentertoRangeShifterDistance.
	 */
	public float getIsocentertoRangeShifterDistance()
	{
		Object objValue = getValue(0x300A,0x0364);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the RangeShifterWaterEquivalentThickness.
	 * @param fRangeShifterWaterEquivalentThickness Float value of Range Shifter Water Equivalent Thickness
	 */
	public void setPresentationPixelMagnificationRatio( float fRangeShifterWaterEquivalentThickness)
	{
		/*
		 * Accept the RangeShifterWaterEquivalentThickness 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,0x0366, fRangeShifterWaterEquivalentThickness,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0366,DicomConstants.DCM_DT_FL, fRangeShifterWaterEquivalentThickness);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the RangeShifterWaterEquivalentThickness.
	 * @return float - Float value of the Ratio of Range Shifter Water Equivalent Thickness.
	 */
	public float getRangeShifterWaterEquivalentThickness()
	{
		Object objValue = getValue(0x300A,0x0366);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
