/*******************************************************************************
 *  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.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IItem;
import cdac.medinfo.sdk.dcm30_04.enums.EnumLensSegmentType;
import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidMacroException;
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 class contains Macro that describes the attributes for the Lensometry Measurements.
 * @author saloni
 *
 */
public class LensometryMeasurementsMacro extends Macro   
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	CylinderSequenceMacro objCylinderSequenceMacro = null;
	PrismSequenceMacro objPrismSequenceMacro = null;

	/**
	 * This constructor constructs a Macro with specified DataSet.
	 * @param objDataSet Collection of DataElements 
	 */
	public LensometryMeasurementsMacro(IDataSet objDataSet)
	{
		super(objDataSet);
	}

	/**
	 * This constructor constructs a Macro with specified DataSet and DictionaryReader
	 * @param objDataSet specifies the DataSet
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public LensometryMeasurementsMacro(IDataSet objDataSet,IDictionaryReader objDictionaryReader)
	{
		super(objDataSet,objDictionaryReader);
	}

	/**
	 * This constructor constructs a Macro with the specified Item
	 * @param objItem specifies instance of Item class
	 */
	public LensometryMeasurementsMacro(IItem objItem)
	{
		super(objItem);
	}

	/**
	 * This constructor constructs a Macro with the specified Item and DictionaryReader
	 * @param objItem specifies instance of Item class
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	public LensometryMeasurementsMacro(IItem objItem,IDictionaryReader objDictionaryReader)
	{
		super(objItem, objDictionaryReader);
	}

	/**
	 * Validates all the attributes in LensometryMeasurementsMacro
	 * @return boolean - Success -true, Failure -false.
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public boolean validate() throws InvalidMacroException
	{
		if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
			return validate(objIDataSet);
		else if(iMacroLevel == DicomConstants.DCM_ITEM_LEVEL_MACRO)
			return validate(objIItem);
		return false;
	}

	/**
	 * Validates all the attributes in LensometryMeasurementsMacro that are present in the DataSet
	 * @param objIDataSet collection of DataElements
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IDataSet objIDataSet) throws InvalidMacroException
	{
		try
		{ 

			//validate condition here
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException( LensometryMeasurementsMacro.class.getSimpleName() ,ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(LensometryMeasurementsMacro.class.getSimpleName() ,me);
		}
		return true;
	}

	/**
	 * Validates all the attributes in LensometryMeasurementsMacro that are present in the DataSet
	 * @param objIItem collection of DataElements in a sequence
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidMacroException throws InvalidMacroException If Mandatory or Conditional element fails.
	 */
	public static boolean validate(IItem objIItem) throws InvalidMacroException
	{
		try
		{  
			//validate condition here
		}
		catch( ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new InvalidMacroException(LensometryMeasurementsMacro.class.getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidMacroException(LensometryMeasurementsMacro.class.getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets the Sphere Power.
	 * @param dblSpherePower Double value of Sphere Power
	 */
	public void setSpherePower(double dblSpherePower)
	{
		/*Accept the Sphere Power in double format of type FD.
		 * 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(0x0046,0x0146, dblSpherePower, objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0046,0x0146,DicomConstants.DCM_DT_FD, dblSpherePower);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Sphere Power.
	 * @return double - double value of Sphere Power
	 */
	public double getSpherePower()
	{
		Object objValue = getValue(0x0046,0x0146);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * This method returns the CylinderSequence Macro with proper initialization.
	 * @return - instance of {@link CylinderSequenceMacro} 
	 */
	public CylinderSequenceMacro getCylinderSequenceMacro()
	{
		if(objCylinderSequenceMacro == null)
		{
			if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
				objCylinderSequenceMacro = new CylinderSequenceMacro(objIDataSet);
			else 
				objCylinderSequenceMacro = new CylinderSequenceMacro(objIItem);

			return objCylinderSequenceMacro;
		}
		return objCylinderSequenceMacro;
	}
	
	/**
	 * Retrieves pre-initialized object of Add Near Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence.
	 * @return AddNearSequence - instance of AddNearSequence. 
	 */
	public AddNearSequence getAddNearSequence()
	{
		AddNearSequence objAddNearSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0046, 0x0100);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAddNearSequence = (AddNearSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAddNearSequence = (AddNearSequence)objDicomV3Factory.createSequence(0x0046, 0x0100, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0046, 0x0100, objAddNearSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0046, 0x0100, DicomConstants.DCM_DT_SQ, objAddNearSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAddNearSequence;
	}
	
	/**
	 * Retrieves pre-initialized object of Add Intermediate Sequence.If the module contains the sequence object
	 * it returns the same otherwise it creates the sequence adds to the module with proper initialization
	 * and then returns the object of sequence.
	 * @return AddIntermediateSequence - instance of AddIntermediateSequence. 
	 */
	public AddIntermediateSequence getAddIntermediateSequence()
	{
		AddIntermediateSequence objAddIntermediateSequence = null;
		IDataElement objIDataElement =  getDataElement(0x0046, 0x0101);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objAddIntermediateSequence = (AddIntermediateSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objAddIntermediateSequence = (AddIntermediateSequence)objDicomV3Factory.createSequence(0x0046, 0x0101, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0046, 0x0101, objAddIntermediateSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0046, 0x0101, DicomConstants.DCM_DT_SQ, objAddIntermediateSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objAddIntermediateSequence;
	}
	
	/**
	 * This method returns the PrismSequence Macro with proper initialization.
	 * @return - instance of {@link PrismSequenceMacro} 
	 */
	public PrismSequenceMacro getPrismSequenceMacro()
	{
		if(objPrismSequenceMacro == null)
		{
			if(iMacroLevel == DicomConstants.DCM_MODULE_LEVEL_MACRO)
				objPrismSequenceMacro = new PrismSequenceMacro(objIDataSet);
			else 
				objPrismSequenceMacro = new PrismSequenceMacro(objIItem);

			return objPrismSequenceMacro;
		}
		return objPrismSequenceMacro;
	}
	
	/**
	 * Sets type of Lens Segment.
	 * Defined Terms:
	 * 1) PROGRESSIVE.
	 * 2) NONPROGRESSIVE.
	 * @param enumLensSegmentType enum value of Lens Segment Type.
	 */
	public void setLensSegmentType(EnumLensSegmentType enumLensSegmentType)
	{
		/* Accept the Lens Segment 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(0x0046,0x0038, enumLensSegmentType.getValue(), objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0046,0x0038,DicomConstants.DCM_DT_CS, enumLensSegmentType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of Lens Segment. 
	 * @return String - value of Lens Segment Type.
	 */
	public String getLensSegmentType()
	{
		Object objValue = getValue(0x0046,0x0038);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets the Optical Transmittance.
	 * @param dblOpticalTransmittance Double value of Optical Transmittance
	 */
	public void setOpticalTransmittance(double dblOpticalTransmittance)
	{
		/*Accept the Optical Transmittance in double format of type FD.
		 * 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(0x0046,0x0040, dblOpticalTransmittance, objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0046,0x0040,DicomConstants.DCM_DT_FD, dblOpticalTransmittance);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Optical Transmittance.
	 * @return double - double value of Optical Transmittance
	 */
	public double getOpticalTransmittance()
	{
		Object objValue = getValue(0x0046,0x0040);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the Channel Width.
	 * @param dblChannelWidth Double value of Channel Width
	 */
	public void setChannelWidth(double dblChannelWidth)
	{
		/*Accept the Channel Width in double format of type FD.
		 * 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(0x0046,0x0042, dblChannelWidth, objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0046,0x0042,DicomConstants.DCM_DT_FD, dblChannelWidth);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the Channel Width.
	 * @return double - double value of Channel Width
	 */
	public double getChannelWidth()
	{
		Object objValue = getValue(0x0046,0x0042);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
}
