/*******************************************************************************
 *  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.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 ReferencedCalculatedDoseReferenceSequence}.
 */

public class ReferencedCalculatedDoseReferenceSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	ReferencedCalculatedDoseReferenceSequenceItem()
	{
		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
	 */
	ReferencedCalculatedDoseReferenceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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


	/**
	 * Validates all the attributes in ReferencedCalculatedDoseReferenceSequenceItem  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,0x0092))&&(!contains(0x300C,0x0051)))
				throw new ConditionFailedException("value of conditional Element 300C,0051 required if 3008,0092 is not present") ;
			if((!contains(0x300C,0x0051))&&(!contains(0x3008,0x0092)))
				throw new ConditionFailedException("value of conditional Element 3008,0092 required if 300C,0051 is not present") ;
			if(!contains(0x3008,0x0076))
				throw new ConditionFailedException("3008,0076 is required.");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		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 Referenced Calculated Dose Reference Number.Uniquely identifies Calculated Dose Reference specified by Calculated Dose
	 * Reference Number (3008,0072).
	 * @param strReferencedCalculatedDoseReferenceNumber String value of Calculated Dose Reference Number .
	 */
	public void setReferencedCalculatedDoseReferenceNumber(String strReferencedCalculatedDoseReferenceNumber)
	{
		/*Accept the ReferencedCalculatedDoseReferenceNumber 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,0x0092, strReferencedCalculatedDoseReferenceNumber,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0092,DicomConstants.DCM_DT_IS, strReferencedCalculatedDoseReferenceNumber);

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

	/**
	 * Sets Calculated Dose.
	 * @param strCalculatedDoseReferenceDoseValue String value of Calculated Dose Reference Dose Value .
	 */
	public void setCalculatedDoseReferenceDoseValue(String strCalculatedDoseReferenceDoseValue)
	{
		/*Accept the CalculatedDoseReferenceDoseValue 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,0x0076, strCalculatedDoseReferenceDoseValue,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x3008,0x0076,DicomConstants.DCM_DT_DS, strCalculatedDoseReferenceDoseValue);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Calculated Dose.
	 * @return String - value of String value of Calculated Dose Reference Dose Value.
	 */
	public String getCalculatedDoseReferenceDoseValue()
	{
		Object objValue = getValue(0x3008,0x0076);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
