/*******************************************************************************
 *  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.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 item class contains methods to validate, set and get the attributes of Temporal Position Sequence Item .
 */

public class TemporalPositionSequenceItem extends Item
{
	
	
	/**
	* 
	*/
	private static final long serialVersionUID = 1L;
	
	
	/**
	* This constructor creates the item and internal code sequence macro with default TransferSyntax 
	*/
	TemporalPositionSequenceItem()
	{
	super();
	}
	/**
	* This constructor creates the item and internal code sequence macro with default TransferSyntax 
	* and default DictionaryReader
	* @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax
	*/
	TemporalPositionSequenceItem(ITransferSyntax objITransferSyntax)
	{
	super(objITransferSyntax);
	}
	
	/**
	* This constructor creates TemporalPositionSequenceItem with specified TransferSyntax and
	* specified DictionaryReader
	* @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	* @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	*/
	TemporalPositionSequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
	super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Sets the Time offset of the frame in the set of frames with differenttemporal positions, in seconds.
	 * @param dblTemporalPositionTimeOffset Double value of coordinates
	 */
	public void setTemporalPositionTimeOffset(double dblTemporalPositionTimeOffset)
	{
		/*Accept the Temporal Position Time Offset 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(0x0020,0x930D, dblTemporalPositionTimeOffset,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0020,0x930D,DicomConstants.DCM_DT_FD, dblTemporalPositionTimeOffset);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves the value of Temporal Position Time Offset.
	 * @return double - double value of TemporalPositionTimeOffset
	 */
	public double getTemporalPositionTimeOffset()
	{
		Object objValue = getValue(0x0020,0x930D);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	* Validates all the attributes in TemporalPositionSequenceItem  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(0x0020,0x930D))
			throw new MandatoryMissingException("0020,930D");
		
	}
	catch( ConditionFailedException ce)
	{
		if(DicomConfig.createInstance().isLoggingOn())
		{
			DicomLogger.getLogger().log(ce.getMessage());
		}
		throw new InvalidItemException(this.getClass().getSimpleName(),ce); 
	}
	catch( MandatoryMissingException me)
	{
		if(DicomConfig.createInstance().isLoggingOn())
		{
			DicomLogger.getLogger().log(me.getMessage());
		}
		throw new InvalidItemException(this.getClass().getSimpleName(),me);
	}
	return true;
	}

}
