/*******************************************************************************
 *  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.IDicomValue;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.enums.EnumExcessiveFixationLosses;
import cdac.medinfo.sdk.dcm30_04.enums.EnumExcessiveFixationLossesDataFlag;
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 Fixation Sequence .
 */

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

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

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

	/*
	 * (non-Javadoc) This mathod validates the contents of the Item
	 * @see cdac.medinfo.sdk.dcm30_04.commoninterface.IItem#validate()
	 */
	/**
	 * Validates all the attributes in FixationSequenceItem 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(0x0024,0x0033))
				throw new MandatoryMissingException("0024,0033");
			if(!contains(0x0024,0x0035))
				throw new ConditionFailedException("0024,0035");
			if(!contains(0x0024,0x0036))
				throw new ConditionFailedException("0024,0036");
			if(!contains(0x0024,0x0039))
				throw new MandatoryMissingException("0024,0039");
			if(!contains(0x0024,0x0040))
				throw new ConditionFailedException ("0024,0040");
		}catch(ConditionFailedException ce)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ce.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),ce); 
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	/**
	 * Retrieves pre-initialized object of Fixation Monitoring Code 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 FixationMonitoringCodeSequence - instance of Fixation Monitoring Code Sequence. 
	 */
	public FixationMonitoringCodeSequence getFixationMonitoringCodeSequence()
	{
		FixationMonitoringCodeSequence objFixationMonitoringCodeSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0024,0x0033);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objFixationMonitoringCodeSequence = (FixationMonitoringCodeSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objFixationMonitoringCodeSequence = (FixationMonitoringCodeSequence)objDicomV3Factory.createSequence(0x0024,0x0033, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0024,0x0033, objFixationMonitoringCodeSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0024,0x0033, DicomConstants.DCM_DT_SQ, objFixationMonitoringCodeSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objFixationMonitoringCodeSequence;
	}
	/**
	 * Sets FixationCheckedQuantity
	 * @param shFixationCheckedQuantity short value of Fixation Checked Quantity
	 */
	public void setFixationCheckedQuantity(short shFixationCheckedQuantity)
	{
		/* Accept the FixationCheckedQuantity of type US.
		 * 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(0x0024,0x0035,shFixationCheckedQuantity,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0024,0x0035,DicomConstants.DCM_DT_US, shFixationCheckedQuantity);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Fixation Checked Quantity
	 * @return short - short value of Fixation Checked Quantity
	 */
	public short getFixationCheckedQuantity()
	{
		Object objValue = getValue(0x0024,0x0035);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}


	/**
	 * Sets Number of Patient Not Properly Fixated Quantity
	 * @param shPatientNotProperlyFixatedQuantity short value of Number of significant bits
	 */
	public void setPatientNotProperlyFixatedQuantity(short shPatientNotProperlyFixatedQuantity)
	{
		/* Accept the Patient Not Properly Fixated Quantity of type US.
		 * 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(0x0024,0x0036,shPatientNotProperlyFixatedQuantity,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0024,0x0036,DicomConstants.DCM_DT_US, shPatientNotProperlyFixatedQuantity);

		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves PatientNotProperlyFixatedQuantity
	 * @return short - short value of PatientNotProperlyFixatedQuantity
	 */
	public short getPatientNotProperlyFixatedQuantity()
	{
		Object objValue = getValue(0x0024,0x0036);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * Sets type of Excessive Fixation Losses Data Flag
	 * Whether the device was able to determine excessive fixation losses.t.
	 * Defined Terms:
	 * 1)YES	
	 * 2)NO
	 * @param enumExcessiveFixationLossesDataFlag enum value of ExcessiveFixationLossesDataFlag.
	 */
	public void setExcessiveFixationLossesDataFlag(EnumExcessiveFixationLossesDataFlag enumExcessiveFixationLossesDataFlag)
	{
		/* Accept the Excessive Fixation Losses Data Flag 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(0x0024,0x0039, enumExcessiveFixationLossesDataFlag.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0024,0x0039,DicomConstants.DCM_DT_CS, enumExcessiveFixationLossesDataFlag.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Return type of ExcessiveFixationLosses .
	 * @return String - value of ExcessiveFixationLosses.
	 */
	public String getExcessiveFixationLossesDataFlag()
	{
		Object objValue = getValue(0x0024,0x0039);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets type of Excessive Fixation Losses
	 * The number of fixation losses is outside of implementation-specific limits.
	 * Defined Terms:
	 * 1)YES	
	 * 2)NO
	 * @param enumExcessive Fixation Losses enum value of Excessive Fixation Losses.
	 */
	public void setExcessiveFixationLosses(EnumExcessiveFixationLosses enumExcessiveFixationLosses)
	{
		/* Accept the ExcessiveFixationLosses 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(0x0024,0x0040, enumExcessiveFixationLosses.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0024,0x0040,DicomConstants.DCM_DT_CS, enumExcessiveFixationLosses.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of ExcessiveFixationLosses. 
	 * @return String - value of ExcessiveFixationLosses.
	 */
	public String ExcessiveFixationLosses()
	{
		Object objValue = getValue(0x0024,0x0040);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

}
