/*******************************************************************************
 *  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.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 the methods to set, get and validate the attribute present in Ion Beam Limiting Device Sequence.
 */

public class IonBeamLimitingDeviceSequenceItem extends Item
{

	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item with default TransferSyntax 
	 */
	IonBeamLimitingDeviceSequenceItem()
	{
		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 with specified TransferSyntax 
	 * and default DictionaryReader
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 */
	IonBeamLimitingDeviceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/*
	 * (non-Javadoc) This method validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in IonBeamLimitingDeviceSequenceItem 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,0x00B8))
				throw new MandatoryMissingException("300A,00B8");
			if(!contains(0x300A,0x00BC))
				throw new MandatoryMissingException("300A,00BC");
			if(!contains(0x300A,0x00BE))
				throw new ConditionFailedException("300A,00BE");
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		return true;
	}
	

	/**
	 * Sets type of beam limiting device (collimator).
	 * Defined Terms:
	 * 1) X.
	 * 2) Y.
	 * 3) ASYMX
	 * 4) ASYMY.
	 * 5) MLCX.
	 * 6) MLCY.
	 * @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);
	}

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

	/**
	 * Sets the IsocentertoBeamLimitingDeviceDistance.
	 * @param fIsocentertoBeamLimitingDeviceDistance Float value of the Isocenter to Beam Limiting Device Distance.
	 */
	public void setIsocentertoBeamLimitingDeviceDistance( float fIsocentertoBeamLimitingDeviceDistance)
	{
		/*
		 * Accept the IsocentertoBeamLimitingDeviceDistance in String format of type FL.
		 * 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,0x00BB, fIsocentertoBeamLimitingDeviceDistance,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00BB,DicomConstants.DCM_DT_FL, fIsocentertoBeamLimitingDeviceDistance);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the IsocentertoBeamLimitingDeviceDistance.
	 * @return float - Float value of the Isocenter to Beam Limiting Device Distance
	 */
	public float getIsocentertoBeamLimitingDeviceDistance()
	{
		Object objValue = getValue(0x300A,0x00BB);
		if(objValue != null)
			return Float.parseFloat(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets NumberofLeafJawPairs.
	 * Number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws).
	 * @param strNumberofLeafJawPairs String value of Number of Leaf Jaw Pairs.
	 */
	public void setNumberofLeafJawPairs(String strNumberofLeafJawPairs )
	{
		/*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, strNumberofLeafJawPairs ,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00BC,DicomConstants.DCM_DT_IS, strNumberofLeafJawPairs );

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves NumberofLeafJawPairs.
	 * Number of leaf (element) or jaw pairs (equal to 1 for standard beam limiting device jaws).
	 * @return String - value of NumberofLeafJawPairs.
	 */
	public String getNumberofLeafJawPairs()
	{
		Object objValue = getValue(0x300A,0x00BC);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets LeafPositionBoundaries.
	 * @param strArrLeafPositionBoundaries String value of Leaf Position Boundaries.
	 */
	public void setLeafPositionBoundaries(String[] strArrLeafPositionBoundaries)
	{
		/*Accept the LeafPositionBoundaries 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(0x300A,0x00BE, strArrLeafPositionBoundaries,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00BE,DicomConstants.DCM_DT_DS, strArrLeafPositionBoundaries);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Leaf Position Boundaries.
	 * @return String - value of LeafPositionBoundaries.
	 */
	public String[] getLeafPositionBoundaries()
	{
		Object objValue = getValue(0x300A,0x00BE);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	

}
