/*******************************************************************************
 *  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.dicommodel.modules;




import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.GatedInformationSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBeatRejectionFlag;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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.utils.ICollectionIterator;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module specifies Attributes that describe a multi-gated acquisition image performed on the
 * patient. This refers to frames acquired while the patient is connected to a gating device.
 * 
 * 
 */
public class NMMultiGatedAcquisitionModule extends Module  
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;


	/**
	 * Instantiates a new nM multi gated acquisition module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public NMMultiGatedAcquisitionModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1080));
		objSingleCollection.add(new Tag(0x0018,0x1085));
		objSingleCollection.add(new Tag(0x0018,0x1086));
		objSingleCollection.add(new Tag(0x0018,0x1088));
		objSingleCollection.add(new Tag(0x0054,0x0062));
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return boolean - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */	
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			
			if(isPresent(0x0028,0x0009))
			{
				NMMultiFrameModule objNMMultiFrameModule = new NMMultiFrameModule(objIDataSet);
				ISingleCollection<ITag> objSingleCollection = objNMMultiFrameModule.getFrameIncrementPointer();
				ICollectionIterator<ITag> objCollectionIterator = objSingleCollection.iterator();
				ITag objITag = null;boolean flag = false;
				while(objCollectionIterator.hasNext())
				{
					objITag = objCollectionIterator.next();
					if(objITag.equals(new Tag(0x0054,0x0062)))
					{
						flag=true;
						break;
					}
				}
				if(flag && (!isPresent(0x0054,0x0062)))
					throw new ConditionFailedException("0054,0062 is Required if Frame Increment Pointer (0028,0009) contains the Tag for R-R Interval Vector (0054,0060).");
			}
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),cfe);

		}
		return true;
	}

	/**
	 * Sets Heart beat duration sorting has been applied. Enumerated Values: Y = yes, N = no.
	 * 
	 * @param enumBeatRejectionFlag the enum beat rejection flag
	 */
	public void setBeatRejectionFlag(EnumBeatRejectionFlag enumBeatRejectionFlag)
	{
		/*Accept Beat Rejection 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 Hash Map
		 */
		addDataElement(0x0018, 0x1080, DicomConstants.DCM_DT_CS, enumBeatRejectionFlag.getValue());
	}

	/**
	 * Sets Description of type of arrhythmic beat rejection criteria used.
	 * 
	 * @param strPVCRejection - String value of beat rejection criteria used
	 */
	public void setPVCRejection(String strPVCRejection)
	{
		/*Accept PVC Rejection in String format of type LO.
		 * 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 Hash Map
		 */
		addDataElement(0x0018, 0x1085, DicomConstants.DCM_DT_LO, strPVCRejection);
	}

	/**
	 * Sets Number of beats skipped after a detected arrhythmia.
	 * 
	 * @param strSkipBeats - String value of Number of beats skipped
	 */
	public void setSkipBeats(String strSkipBeats)
	{
		/*Accept Skip Beats 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 Hash Map
		 */
		addDataElement(0x0018, 0x1086, DicomConstants.DCM_DT_IS, strSkipBeats);
	}

	/**
	 * Sets Average number of heart beats per minute for the collection period for these
	 * frames. This shall include all accepted beats as well as rejected beats.
	 * 
	 * @param strHeartRate - String value number of  heart beats
	 */
	public void setHeartRate(String strHeartRate)
	{
		/*Accept Heart Rate 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 Hash Map
		 */
		addDataElement(0x0018, 0x1088, DicomConstants.DCM_DT_IS, strHeartRate);
	}

	/**
	 * Retrieves Sequence of Repeating Items that describe R-R intervals. Each gated interval is defined by an upper and lower
	 * range of heart beat durations. Required if the Frame Increment Pointer (0028,0009) contains the Tag for R-R Interval Vector
	 * (0054,0060). The number of items shall be equal to Number of R-R Intervals (0054,0061). The first item corresponds to
	 * frames with value of 1 in the R-R Interval Vector (0054,0060), the second item with value 2, etc.
	 * 
	 * @return - instance of GatedInformationSequence
	 */
	public GatedInformationSequence getGatedInformationSequence()
	{
		GatedInformationSequence objGatedInformationSequence = (GatedInformationSequence)getDicomValue(0x0054, 0x0062);
		if(objGatedInformationSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objGatedInformationSequence = (GatedInformationSequence)objDicomV3Factory.createSequence(0x0054, 0x0062, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0054, 0x0062, DicomConstants.DCM_DT_SQ, objGatedInformationSequence.getValue());
		}
		return objGatedInformationSequence;
	}

	/**
	 * Retrieves Heart beat duration sorting has been applied.
	 * 
	 * @return String - String value of Beat Rejection Flag.
	 */
	public String getBeatRejectionFlag()
	{Object objectValue = getValue(0x0018,0x1080);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Description of type of arrhythmic beat rejection criteria used.
	 * 
	 * @return String - String value of beat rejection criteria used.
	 */
	public String getPVCRejection()
	{Object objectValue = getValue(0x0018,0x1085);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Number of beats skipped after a detected arrhythmia.
	 * 
	 * @return the skip beats
	 */
	public String getSkipBeats()
	{Object objectValue = getValue(0x0018,0x1086);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/**
	 * Retrieves Average number of heart beats per minute.
	 * 
	 * @return the heart rate
	 */
	public String getHeartRate()
	{Object objectValue = getValue(0x0018,0x1088);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}

	/* 
	 * I have modified the collection type from vector to custom class
	 * This method is used by the Module Iterator to iterate through the DataSet and return only
	 * those elements that belong to the respective Module class whose getVectorOfKeys is called.
	 */
	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}