/*******************************************************************************
 *  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.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.MandatoryMissingException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ValidationException;
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 in {@link ReferencedMeasuredDoseReferenceSequence}.
 */

public class ReferencedMeasuredDoseReferenceSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ReferencedMeasuredDoseReferenceSequenceItem()
	{
		super();
	}

	/*
	 * This constructor calls the respective superclass constructor
	 * This constructor should throw exception if null TS is tried to be set
	 */
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	ReferencedMeasuredDoseReferenceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in {@link ReferencedMeasuredDoseReferenceSequenceItem} and
	 * {@link TreatmentSummaryCalculatedDoseReferenceSequence} 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
	{
		try{
			if((contains(0x3008,0x0051))^(contains(0x3008,0x0082)))
				throw new ConditionFailedException("(3008,0051)and (3008,0082) Both cannot be present or absent at the same time") ;
			if(!(contains(0x3008,0x0016)))
				throw new ConditionFailedException("3008,0016 should be present");

		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * 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 ReferencedDoseReferenceNumber 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 strReferencedMeasuredDoseReferenceNumber String value of Referenced Measured Dose Reference Number.
	 */
	public void setReferencedMeasuredDoseReferenceNumber(String strReferencedMeasuredDoseReferenceNumber)
	{
		/*Accept the Referenced Measured Dose Reference Number 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,0x0082, strReferencedMeasuredDoseReferenceNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0082,DicomConstants.DCM_DT_IS, strReferencedMeasuredDoseReferenceNumber);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Referenced Measured Dose Reference Number.
	 * @return String - value of Referenced Measured Dose Reference Number.
	 */
	public String getReferencedMeasuredDoseReferenceNumber()
	{
		Object objValue = getValue(0x3008,0x0082);
		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 MeasuredDoseValue 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;
	}
}
