/*******************************************************************************
 *  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.EnumRTBeamLimitingDeviceType;
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 BeamLimitingDeviceLeafPairsSequence}.
 */

public class BeamLimitingDeviceLeafPairsSequenceItem extends Item  
{
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	BeamLimitingDeviceLeafPairsSequenceItem()
	{
		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
	 */
	BeamLimitingDeviceLeafPairsSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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


	/**
	 * Validates all the attributes in BeamLimitingDeviceLeafPairsSequenceItem  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(0x300A,0x00BC))
				throw new MandatoryMissingException("300A,00BC");
			if(!contains(0x300A,0x00B8))
				throw new MandatoryMissingException("300A,00B8");
		}
		catch( MandatoryMissingException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}

	/**
	 * Sets type of beam limiting device (collimator).
	 * @param enumRTBeamLimitingDeviceType Enum value of RT Beam Limiting Device Type.
	 */
	public void setRTBeamLimitingDeviceType(EnumRTBeamLimitingDeviceType enumRTBeamLimitingDeviceType)
	{
		/*Accept the RT Beam Limiting Device 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,0x00B8, enumRTBeamLimitingDeviceType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00B8,DicomConstants.DCM_DT_CS, enumRTBeamLimitingDeviceType.getValue());

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves RT Beam Limiting Device Type.
	 * @return String - value of RT Beam Limiting Device Type.
	 */
	public String getRTBeamLimitingDeviceType()
	{
		Object objValue = getValue(0x300A,0x00B8);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Number of leaf (element) or jaw pairs equal to 1 for standard beam limiting.
	 * @param strNumberOfLeafOrJawPairs String value of Number of Leaf/Jaw Pairs.
	 */
	public void setNumberOfLeafOrJawPairs(String strNumberOfLeafOrJawPairs)
	{
		/*Accept the Number of Leaf/Jaw Pairs 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(0x300A,0x00BC, strNumberOfLeafOrJawPairs,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00BC,DicomConstants.DCM_DT_IS, strNumberOfLeafOrJawPairs);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of leaf (element) or jaw pairs .
	 * @return String - value of Number of Leaf/Jaw Pairs.
	 */
	public String getNumberOfLeafOrJawPairs()
	{
		Object objValue = getValue(0x300A,0x00BC);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
