/*******************************************************************************
 *  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.enums.EnumDoseUnits;
import cdac.medinfo.sdk.dcm30_04.enums.EnumMeasuredDoseType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
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 introduces sequence of doses measured during treatment delivery, summed over entire session.
 * The sequence may contain one or more items.
 */
public class MeasuredDoseReferenceSequenceItem extends Item  
{
	

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

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

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

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

	/**
	 * Sets Referenced Dose Reference Number .Uniquely identifies Dose Reference specified by Dose Reference Number(300A,0012) in Dose Reference Sequence(300A,0010) in RT Prescription Module of referenced RT Plan.
	 * @param strReferencedDoseReferenceNumber String value of Referenced Dose Reference Number.
	 */
	public void setReferencedDoseReferenceNumber(String strReferencedDoseReferenceNumber)
	{
		/*Accept the Value Type 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,0x0051, strReferencedDoseReferenceNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0051,DicomConstants.DCM_DT_IS, strReferencedDoseReferenceNumber);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Referenced Dose Reference Number.
	 * @return String - value of Referenced Dose Reference Number.
	 */
	public String getReferencedDoseReferenceNumber()
	{
		Object objValue = getValue(0x300C,0x0051);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Measured Dose Reference Number. Unique identifier of measured dose point.
	 * @param strMeasuredDoseReferenceNumber String value of Measured Dose Reference Number .
	 */
	public void setMeasuredDoseReferenceNumber(String strMeasuredDoseReferenceNumber)
	{
		/*Accept the Value Type 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(0x3008,0x0064, strMeasuredDoseReferenceNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0064,DicomConstants.DCM_DT_IS, strMeasuredDoseReferenceNumber);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Measured Dose Reference Number.
	 * @return String - value of Measured Dose Reference Number.
	 */
	public String getMeasuredDoseReferenceNumber()
	{
		Object objValue = getValue(0x3008,0x0064);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets units used to describe measured dose.
	 * @param enumDoseUnits Enum Value of Dose Units
	 * Enumerated Values:
	 * GY = Gray,
	 * RELATIVE = Dose relative to implicit reference value
	 */
	public void setDoseUnits(EnumDoseUnits enumDoseUnits)
	{
		/*Accept the Value Type in EnumDoseUnits. 
		 * It is String format of type CS.
		 * 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(0x3004,0x0002, enumDoseUnits.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3004,0x0002,DicomConstants.DCM_DT_CS, enumDoseUnits.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves units used to describe measured dose.
	 * @return String - value of Dose Units.
	 */
	public String getDoseUnits()
	{
		Object objValue = getValue(0x3004,0x0002);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Measured Dose in units specified by Dose Units (3004, 0002).
	 * @param strMeasuredDoseValue String value of Measured Dose Value .
	 */
	public void setMeasuredDoseValue(String strMeasuredDoseValue)
	{
		/*Accept the Value Type 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(0x3008,0x0016, strMeasuredDoseValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0016,DicomConstants.DCM_DT_DS, strMeasuredDoseValue);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Measured Dose in units specified by Dose Units (3004, 0002).
	 * @return String - value of  Measured Dose Value.
	 */
	public String getMeasuredDoseValue()
	{
		Object objValue = getValue(0x3008,0x0016);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets User-defined description of Dose Reference.
	 * @param strMeasuredDoseDescription String value of Measured Dose Description .
	 */
	public void setMeasuredDoseDescription(String strMeasuredDoseDescription)
	{
		/*Accept the Value Type in String format of type ST.
		 * 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(0x3008,0x0012, strMeasuredDoseDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0012,DicomConstants.DCM_DT_ST, strMeasuredDoseDescription);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves User-defined description of Dose Reference.
	 * @return String - value of  Measured Dose Description.
	 */
	public String getMeasuredDoseDescription()
	{
		Object objValue = getValue(0x3008,0x0012);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Type of dose measurement.
	 * @param enumMeasuredDoseType Enum value of Measured Dose Type
	 * Defined Terms:
	 * DIODE = semiconductor diode,
	 * TLD = thermoluminescent dosimeter,
	 * ION_CHAMBER = ion chamber,
	 * GEL = dose sensitive gel,
	 * EPID = electronic portal imaging device,
	 * FILM = dose sensitive film.
	 */
	public void setMeasuredDoseType(EnumMeasuredDoseType enumMeasuredDoseType)
	{
		/*Accept the Value Type in EnumMeasuredDoseType. 
		 * It is String format of type CS.
		 * 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(0x3008,0x0014, enumMeasuredDoseType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0014,DicomConstants.DCM_DT_CS, enumMeasuredDoseType.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Type of dose measurement.
	 * @return String - value of Measured Dose Type.
	 */
	public String geMeasuredDoseType()
	{
		Object objValue = getValue(0x3008,0x0014);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Validates all the attributes in MeasuredDoseReferenceSequenceItem  that are present in the DataSet
	 * @return int - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException If Mandatory or Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		try
		{
			if(!contains(0x3004,0x0002))
				throw new MandatoryMissingException("3004,0002");
			else if (!contains(0x3008,0x0016))
				throw new MandatoryMissingException("3008,0016");
			else if (!contains(0x3008,0x0014))
				throw new MandatoryMissingException("3008,0014");

			if((!contains(0x3008,0x0064))&&(!contains(0x300C,0x0051)))
				throw new ConditionFailedException("value of conditional Element 300C,0051 required if 3008,0064 is not present") ;
			if((!contains(0x300C,0x0051))&&(!contains(0x3008,0x0064)))
				throw new ConditionFailedException("value of conditional Element 3008,0064 required if 300C,0051 is not present") ;
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
}
