/*******************************************************************************
 *  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.InvalidMacroException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;

import cdac.medinfo.sdk.dcm30_04.enums.EnumFilterType;
import cdac.medinfo.sdk.dcm30_04.enums.EnumFilterMaterial;



/**
 * This Item class provides methods to set,get and validate the attributes in {@link CTXrayDetailsSequence}
 */
public class CTXrayDetailsSequenceItem extends Item  
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	/**
	 * This constructor creates the item and internal CT XrayDetails Sequence Item with default TransferSyntax 
	 * and default DictionaryReader.
	 */
	CTXrayDetailsSequenceItem()
	{
		super();
	}

	/**
	 * This constructor creates the item and internal CT XrayDetails Sequence Item with default TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax 
	 */
	CTXrayDetailsSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}
	/**
	 * This constructor creates 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 
	 */
	CTXrayDetailsSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in CTXrayDetailsSequenceItem 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
		{
			/*
			 *  Since this class is implemented while implementing MACRO, Validations required for modules
			 *  is not cleared that is modules using this item is not known now.
			 *  Validation conditions for attributes of these Item is not cleared.  
			 *  Refer p.d.f Chapter 3
			 *  Page No :- 655
			 */
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ce);
		}
		catch( InvalidMacroException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ime.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ime);
		}
		return true;
	}
	
		
	/**
	 * Sets Peak kilo voltage
	 * @param strKVP - String value of Peak kilo voltage output of the x-ray generator used.
	 */
	public void setPeakKiloVoltage(String strKVP)
	{
		/*Accept the Peak kilo voltage 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(0x0018,0x0060, strKVP,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x0060,DicomConstants.DCM_DT_DS, strKVP);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Peak kilo voltage.
	 * @return String - value of Peak kilo voltage output of the x-ray generator used.
	 */
	public String getPeakKiloVoltage()
	{
		Object objValue = getValue(0x0018,0x0060);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Focal Spots
	 * @param strFocalSpots-a String array value of Focal Spots .
	 */
	public void setFocalSpots(String[] strFocalSpots)
	{
		/*Accept the Focal Spots in String format array 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(0x0018,0x1190, strFocalSpots,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1190,DicomConstants.DCM_DT_DS, strFocalSpots);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Focal Spots.
	 * @return String[] - value of Focal Spots
	 */
	public String[] getFocalSpots()
	{
		Object objValue = getValue(0x0018,0x1190);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Sets the Filter Type inserted into the X-Ray beam
	 * @param strFilterType -Specifies Filter Type inserted into the X-Ray beam
	 */
	public void setFilterType(EnumFilterType enumFilterType)
	{
		/*Accept the Filter Type 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(0x0018,0x1160, enumFilterType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1160,DicomConstants.DCM_DT_SH, enumFilterType.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves type of the value encoded in this Item
	 * @return EnumFilterType - Type of the value encoded in this Item
	 */
	public EnumFilterType getFilterType()
	{
		Object objValue = getValue(0x0018,0x1160);
		if(objValue != null)
			return EnumFilterType.valueOf(objValue.toString());
		return null;
	}
	
	/**
	 * Sets Filter Material.
	 * @param enumArrayFilterMaterial
	 */
	public void setFilterMaterial(EnumFilterMaterial[] enumArrayFilterMaterial)
	{
		/*Accept the Array of FilterMaterial 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(0x0018,0x7050, enumArrayFilterMaterial,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x7050,DicomConstants.DCM_DT_CS,enumArrayFilterMaterial);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Filter Material.
	 * @return String value of Filter Material.
	 */
	public EnumFilterMaterial[] getConvolutionKernel()
	{
		Object objValue = getValue(0x0018,0x7050);
		if(objValue != null)
			return (EnumFilterMaterial[])objValue;
		return null;
	}

}
