/*******************************************************************************
 *  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.EnumRangeModulatorType;
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 of Recorded Range Modulator Sequence .
 */


public class RecordedRangeModulatorSequenceItem extends Item
{
	


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


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

	/**
	 * This constructor creates Recorded Range Modulator 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 .
	 */
	RecordedRangeModulatorSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}
	
	/**
	 * Validates all the attributes in RecordedRangeModulatorSequenceItem according the rules defined by the Recorded Range Modulator 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,0x0104))
				throw new MandatoryMissingException("300C,0104");
			if(!contains(0x300A,0x0346))
				throw new MandatoryMissingException("300A,0346");
			if(!contains(0x300A,0x0348))
				throw new MandatoryMissingException("300A,0348");
			if(contains(0x300A,0x0348) && getDataForTag(0x300A, 0x0348).getValue().toString().equals(EnumRangeModulatorType.WHL_MODWEIGHTS))
				if(!contains(0x300A,0x034C))
					throw new ConditionFailedException("0x300A,0x034C");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	
	/**
	 * Sets Referenced Range Modulator Number.
	 * @param strReferencedRangeModulatorNumber String value of Referenced Range Modulator Number.
	 */
	public void setReferencedRangeModulatorNumber (String strReferencedRangeModulatorNumber)
	{
		/*Accept the Referenced Range Modulator 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(0x300C,0x0104, strReferencedRangeModulatorNumber ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300C,0x0104,DicomConstants.DCM_DT_IS, strReferencedRangeModulatorNumber );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Referenced Range Modulator Number.
	 * @return String - value of Referenced Range Modulator Number.
	 */
	public String getReferencedRangeModulatorNumber()
	{
		Object objValue = getValue(0x300C,0x0104);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Range Modulator ID.
	 * @param strRangeModulatorID
	 */
	public void setRangeModulatorID(String strRangeModulatorID)
	{
		/*Accept the Range Modulator ID in String format of type SH.
		 * 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, 0x0346, strRangeModulatorID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x300A, 0x0346,DicomConstants.DCM_DT_SH, strRangeModulatorID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Range Modulator ID.
	 * @return String - value of Range Modulator ID.
	 */
	public String getRangeModulatorID()
	{
		Object objValue = getValue(0x300A, 0x0346);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Accessory Code.
	 * @param strAccessoryCode String value of Accessory Code.
	 */
	public void setAccessoryCode(String strAccessoryCode)
	{
		/* Accept the Accessory Code 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,0x00F9, strAccessoryCode,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00F9,DicomConstants.DCM_DT_LO, strAccessoryCode);

		addDataElement(objIDataElement);
	}

	/**
	 * Return Accessory Code.
	 * @return String - value of Accessory Code.
	 */
	public String getAccessoryCode()
	{
		Object objValue = getValue(0x300A,0x00F9);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Range Modulator Type
	 * Defined Terms:
	 * 1) FIXED.
	 * 2) WHL_FIXEDWEIGHTS.
	 * 3) WHL_MODWEIGHTS.
	 * @param enumRangeModulatorType enum value of RangeModulatorType.
	 */
	public void setRangeModulatorType(EnumRangeModulatorType enumRangeModulatorType)
	{
		/* Accept the Range Modulator Type in 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(0x300A,0x0348, enumRangeModulatorType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x0348,DicomConstants.DCM_DT_CS, enumRangeModulatorType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Range Modulator Type. 
	 * @return String - value of Range Modulator Type.
	 */
	public String getRangeModulatorType()
	{
		Object objValue = getValue(0x300A,0x0348);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Beam Current Modulation ID.
	 * @param strBeamCurrentModulationID
	 */
	public void setBeamCurrentModulationID(String strBeamCurrentModulationID)
	{
		/*Accept the Beam Current Modulation ID in String format of type SH.
		 * 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, 0x034C, strBeamCurrentModulationID,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x300A, 0x034C,DicomConstants.DCM_DT_SH, strBeamCurrentModulationID);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Beam Current Modulation ID.
	 * @return String - value of Beam Current Modulation ID.
	 */
	public String getBeamCurrentModulationID()
	{
		Object objValue = getValue(0x300A, 0x034C);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
