/*******************************************************************************
 *  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.InvalidItemException;
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 item class contains methods to validate, set and get attributes in {@link MRSpectroscopyFOVGeometrySequence}. 
*/
public class MRSpectroscopyFOVGeometrySequenceItem extends Item
{
	

	/**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
	 * This constructor creates the item and internal MR Echo Macro with default TransferSyntax 
	 */
	MRSpectroscopyFOVGeometrySequenceItem()
	{
		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 MR Echo Macro with specified TS
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax 
	 */
	MRSpectroscopyFOVGeometrySequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

	/**
	 * This constructor creates the item and internal MR Echo Macro with default TransferSyntax 
	 * and default DictionaryReader
	 * @param objTransferSyntax specifies the DICOM Standard defined TransfeSyntax
	 * @param objDictionaryReader specifies the DICOM Dictionary reader to be used 
	 */
	MRSpectroscopyFOVGeometrySequenceItem(ITransferSyntax objTransferSyntax, IDictionaryReader objDictionaryReader)
	{
		super(objTransferSyntax,objDictionaryReader);
	}

	/**
	 * Validates all the attributes in CodeSequenceMacro 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
		{
			/*
			 *  Since this class is implemented while implementing MACRO, Validations required for modules
			 *  is not cleared that is modules using this item is not known now.
			 *  Validation conditions for attributes of these Item is not cleared.  
			 *  Refer p.d.f Chapter 3
			 *  Page No :- 631
			 */
		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),me);
		}
		catch( InvalidMacroException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(ime.getMessage());
			}
			throw new InvalidItemException(this.getClass().getSimpleName(),ime);
		}
		return true;
	}

	/**
	 * Sets Number of data points in the columns direction.
	 * @param iSpectroscopyAcquisitionDataColumns long value of Spectroscopy Acquisition Data Columns.
	 */
	public void setSpectroscopyAcquisitionDataColumns(int iSpectroscopyAcquisitionDataColumns)
	{
		/* Accept the Spectroscopy Acquisition Data Columns of type UL.
		 * 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(0x0018,0x9127, iSpectroscopyAcquisitionDataColumns,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9127,DicomConstants.DCM_DT_UL, iSpectroscopyAcquisitionDataColumns);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of data points in the columns direction.
	 * @return long - value of Number of data points in the columns direction.
	 */
	public int getSpectroscopyAcquisitionDataColumns()
	{
		Object objValue = getValue(0x0018,0x9127);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Number of Phase Encoding Rows.
	 * @param iSpectroscopyAcquisitionPhaseRows long value of Spectroscopy Acquisition Phase Rows.
	 */
	public void setSpectroscopyAcquisitionPhaseRows(int iSpectroscopyAcquisitionPhaseRows)
	{
		/* Accept the Spectroscopy Acquisition Phase Rows of type UL.
		 * 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(0x0018,0x9095, iSpectroscopyAcquisitionPhaseRows,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9095,DicomConstants.DCM_DT_UL, iSpectroscopyAcquisitionPhaseRows);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of Phase Encoding Rows.
	 * @return long - value of Number of Phase Encoding Rows.
	 */
	public int getSpectroscopyAcquisitionPhaseRows()
	{
		Object objValue = getValue(0x0018,0x9095);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Number of Phase Encoding Columns.
	 * @param iSpectroscopyAcquisitionPhaseColumns long value of Spectroscopy Acquisition Phase Columns.
	 */
	public void setSpectroscopyAcquisitionPhaseColumns(int iSpectroscopyAcquisitionPhaseColumns)
	{
		/* Accept the Spectroscopy Acquisition Phase Columns of type UL.
		 * 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(0x0018,0x9234, iSpectroscopyAcquisitionPhaseColumns,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9234,DicomConstants.DCM_DT_UL, iSpectroscopyAcquisitionPhaseColumns);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of Phase Encoding Columns.
	 * @return long - value of Number of Phase Encoding Columns.
	 */
	public int getSpectroscopyAcquisitionPhaseColumns()
	{
		Object objValue = getValue(0x0018,0x9234);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Number of out-of-plane Phase Encoding steps.
	 * @param iSpectroscopyAcquisitionOutofplanePhaseSteps long value of Spectroscopy Acquisition Out-of-plane Phase Steps.
	 */
	public void setSpectroscopyAcquisitionOutofplanePhaseSteps(int iSpectroscopyAcquisitionOutofplanePhaseSteps)
	{
		/* Accept the Spectroscopy Acquisition Out-of-plane Phase Steps of type UL.
		 * 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(0x0018,0x9159, iSpectroscopyAcquisitionOutofplanePhaseSteps,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9159,DicomConstants.DCM_DT_UL, iSpectroscopyAcquisitionOutofplanePhaseSteps);
		//Add the DataElement to the Item
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Number of out-of-plane Phase Encoding steps.
	 * @return long - value of Number of out-of-plane Phase Encoding steps.
	 */
	public int getSpectroscopyAcquisitionOutofplanePhaseSteps()
	{
		Object objValue = getValue(0x0018,0x9159);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets Fraction of acquisition matrix lines acquired, expressed as a percent.
	 * @param strPercentSampling String value of Total Reference Air Kerma.
	 */
	public void setPercentSampling(String strPercentSampling)
	{
		/*Accept the Percent Sampling in String format of type DS.
		 * 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(0x0018,0x0093, strPercentSampling,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x0093,DicomConstants.DCM_DT_DS, strPercentSampling);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Fraction of acquisition matrix lines acquired, expressed as a percent.
	 * @return String - value of PercentSampling.
	 */
	public String getPercentSampling()
	{
		Object objValue = getValue(0x0018,0x0093);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Ratio of field of view dimension in phase direction to field of view dimension in frequency direction,
	 *  expressed as a percent.
	 * @param strPercentPhaseFieldOfView String value of Percent Phase Field of View
	 */
	public void setPercentPhaseFieldOfView(String strPercentPhaseFieldOfView)
	{
		/*Accept the Percent Phase Field of View in String format of type DS.
		 * 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(0x0018,0x0094, strPercentPhaseFieldOfView,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x0094,DicomConstants.DCM_DT_DS, strPercentPhaseFieldOfView);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Fraction of acquisition matrix lines acquired, expressed as a percent.
	 * @return String - value of PercentPhaseFieldOfView.
	 */
	public String getPercentPhaseFieldOfView()
	{
		Object objValue = getValue(0x0018,0x0094);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
