/*******************************************************************************
 *  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 Beam Dose Verification Control Point Sequence.
 */

public class BeamDoseVerificationControlPointSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax .
	 */
	BeamDoseVerificationControlPointSequenceItem()
	{
		super();
	}


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

	/**
	 * This constructor creates BeamDoseVerificationControlPointSequenceItem with specified TransferSyntax and
	 * specified DictionaryReader.
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	BeamDoseVerificationControlPointSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}


	/**
	 * Validates all the attributes in BeamDoseVerificationControlPointSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x300A,0x0134))
				throw new MandatoryMissingException("300A,0134");
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets Cumulative Meterset Weight.
	 * @param strCumulativeMetersetWeight -String value of Cumulative Meterset Weight.
	 */
	public void setCumulativeMetersetWeight(String strCumulativeMetersetWeight)
	{
		/*Accept the Cumulative Meterset Weight 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(0x300A,0x0134, strCumulativeMetersetWeight,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0134,DicomConstants.DCM_DT_DS, strCumulativeMetersetWeight);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Cumulative Meterset Weight.
	 * @return String - value of Cumulative Meterset Weight.
	 */
	public String getCumulativeMetersetWeight()
	{
		Object objValue = getValue(0x300A,0x0134);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Referenced Control Point Index.
	 * @param strReferencedControlPointIndex -String value of Referenced Control Point Index.
	 */
	public void setReferencedControlPointIndex (String strReferencedControlPointIndex )
	{
		/*Accept the Referenced Control Point Index 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,0x00F0, strReferencedControlPointIndex ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x00F0,DicomConstants.DCM_DT_IS, strReferencedControlPointIndex );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Referenced Control Point Index.
	 * @return String - value of Referenced Control Point Index.
	 */
	public String getReferencedControlPointIndex()
	{
		Object objValue = getValue(0x300C,0x00F0);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Average Beam Dose Point Depth.
	 * @param fAverageBeamDosePointDepth -float  value of Average Beam Dose Point Depth.
	 */
	public void setAverageBeamDosePointDepth (float  fAverageBeamDosePointDepth )
	{
		/*Accept the AverageBeamDosePointDepth in float 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,0x008D, fAverageBeamDosePointDepth ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x008D,DicomConstants.DCM_DT_FL, fAverageBeamDosePointDepth );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Average Beam Dose Point Depth.
	 * @return float  - value of Average Beam Dose Point Depth.
	 */
	public float  getAverageBeamDosePointDepth()
	{
		Object objValue = getValue(0x300A,0x008D);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Average Beam Dose Point Equivalent Depth.
	 * @param fAverageBeamDosePointEquivalentDepth- float value of Average Beam Dose Point Equivalent Depth.
	 */
	public void setAverageBeamDosePointEquivalentDepth(float  fAverageBeamDosePointEquivalentDepth )
	{
		/*Accept the Average Beam Dose Point Depth in float 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,0x008E, fAverageBeamDosePointEquivalentDepth ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x008E,DicomConstants.DCM_DT_FL, fAverageBeamDosePointEquivalentDepth );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Average Beam Dose Point Equivalent Depth.
	 * @return float  - value of Average Beam Dose Point Equivalent Depth.
	 */
	public float getAverageBeamDosePointEquivalentDepth()
	{
		Object objValue = getValue(0x300A,0x008E);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets Average Beam Dose Point SSD.
	 * @param fAverageBeamDosePointSSD -float value of Average Beam Dose Point SSD.
	 */
	public void setAverageBeamDosePointSSD(float  fAverageBeamDosePointSSD )
	{
		/*Accept the Average Beam Dose Point SSD in float 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,0x008F, fAverageBeamDosePointSSD ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x008F,DicomConstants.DCM_DT_FL, fAverageBeamDosePointSSD );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Average Beam Dose Point SSD.
	 * @return float - value of Average Beam Dose Point SSD.
	 */
	public float getAverageBeamDosePointSSD()
	{
		Object objValue = getValue(0x300A,0x008F);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Average Beam Dose Point Source to External Contour Distance.
	 * @param fAverageBeamDosePointSourcetoExternalContourDistance- float value of Average Beam Dose Point Source to External Contour Distance.
	 */
	public void setAverageBeamDosePointSourcetoExternalContourDistance(float fAverageBeamDosePointSourcetoExternalContourDistance)
	{
		/*Accept the Average Beam Dose Point Source to External Contour Distance in float 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,0x0131, fAverageBeamDosePointSourcetoExternalContourDistance ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0131,DicomConstants.DCM_DT_FL, fAverageBeamDosePointSourcetoExternalContourDistance );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Average Beam Dose Point Source to External Contour Distance.
	 * @return float - value of Average Beam Dose Point Source to External Contour Distance.
	 */
	public float getAverageBeamDosePointSourcetoExternalContourDistance()
	{
		Object objValue = getValue(0x300A,0x0131);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
