/*******************************************************************************
 *  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.DigitalXRayDetectorMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.FrameDisplaySequence;
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.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;
//TODO: Auto-generated Javadoc
/**
\* This module describes attributes related to XA Or XRF Multiframe Presentation Module.
*/
public class XAOrXRFMultiframePresentationModule extends Module  
{

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

	/**
	 * 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;
	}


	/**
	 * The obj Digital X Ray Detector Macro.
	 */
	DigitalXRayDetectorMacro objDigitalXRayDetectorMacro = null;

	/**
	 * Instantiates a new waveform identification module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public XAOrXRFMultiframePresentationModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1244));
		objSingleCollection.add(new Tag(0x0018,0x9458));
	}


	/**
	 * 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
		{			
			
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

		}
		catch(InvalidItemException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(iie.getMessage());

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

		}
		return true;
	}
	/**
	 * Sets the preferred playback sequencing for a multi-frame image.
	 * Enumerated Values:
	 * 0 = Looping (1,2...n,1,2,...n,1,2,....n,...)
	 * 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...).
	 * 
	 * @param sPreferredPlaybackSequencing short value of Preferred Playback Sequencing.
	 */
	public void setPreferredPlaybackSequencing(short sPreferredPlaybackSequencing)
	{
		/*Accept Preferred Playback Sequencing in short format 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
		 */
		addDataElement(0x0018,0x1244, DicomConstants.DCM_DT_US, sPreferredPlaybackSequencing);
	}
	/**
	 * Retrieves the preferred playback sequencing for a multi-frame image.
	 * Enumerated Values:
	 * 0 = Looping (1,2...n,1,2,...n,1,2,....n,...)
	 * 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...)
	 * 
	 * @return short - short value of Preferred Playback Sequencing.
	 */
	public short getPreferredPlaybackSequencing()
	{
		Object objValue = getValue(0x0018,0x1244);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * This method provides the pre-initialized object of Frame Display Sequence.
	 * 
	 * @return - object of Frame Display 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
	 */
	public FrameDisplaySequence getFrameDisplaySequence()
	{
		FrameDisplaySequence objFrameDisplaySequence = (FrameDisplaySequence)getDicomValue(0x0018,0x9458);
		if(objFrameDisplaySequence == 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();
			objFrameDisplaySequence = (FrameDisplaySequence)objDicomV3Factory.createSequence(0x0018,0x9458, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0018,0x9458, DicomConstants.DCM_DT_SQ, objFrameDisplaySequence.getValue());
		}
		return objFrameDisplaySequence;
	}

}
