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

import  cdac.medinfo.sdk.dcm30_04.enums.EnumQuadratureReceiveCoil;
/**
* This item class contains methods to validate, set and get attributes in {@link MRReceiveCoilSequence}. 
*/
public class MRReceiveCoilSequenceItem extends Item
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	MRReceiveCoilSequenceItem()
	{
		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
	 */
	MRReceiveCoilSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in {@link MRReceiveCoilSequenceItem} 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 :- 616
			 */
		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(cfe.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),cfe);
		}
		catch( MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}
	
	/**
	 * Sets Name of receive coil used.
	 * @param strReceiveCoilName String value of Template Type.
	 */
	public void setReceiveCoilName(String strReceiveCoilName)
	{
		/*Accept the ReceiveCoilName in String format of type SH.
		 * 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,0x1250, strReceiveCoilName,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1250,DicomConstants.DCM_DT_SH, strReceiveCoilName);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Name of receive coil used.
	 * @return String - value of ReceiveCoilName.
	 */
	public String getReceiveCoilName()
	{
		Object objValue = getValue(0x0018,0x1250);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Name of manufacturer of receive coil.
	 * @param StrReceiveCoilManufacturerName String identifies Organization
	 */	
	public void setReceiveCoilManufacturerName(String StrReceiveCoilManufacturerName)
	{
		/*Accept Receive Coil Manufacturer Name in String format of type LO.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x9041,StrReceiveCoilManufacturerName,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9041, DicomConstants.DCM_DT_LO,StrReceiveCoilManufacturerName);
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Name of manufacturer of receive coil.
	 * @return String - identifies the Organization
	 */
	public String getReceiveCoilManufacturerName()
	{
		Object objValue = getValue(0x0018,0x9041);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Type of receive coil used.
	 * @param enumShapeType Enum value for geometric interpretation of the Contour Data
	 */
	public void setReceiveCoilType(EnumReceiveCoilType enumReceiveCoilType)
	{
		/*Accept the Receive Coil Type 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(0x0018,0x9043, enumReceiveCoilType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9043,DicomConstants.DCM_DT_CS, enumReceiveCoilType.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Type of receive coil used.
	 * @return String - value for The axes of the in-plane phase encoding with respect to the frame.
	 */
	public String getReceiveCoilType()
	{
		Object objValue = getValue(0x0018,0x9043);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Indicates whether the receive coil is quadrature.
	 * @param enumShapeType Enum value for geometric interpretation of the Contour Data
	 */
	public void setQuadratureReceiveCoil(EnumQuadratureReceiveCoil enumQuadratureReceiveCoil)
	{
		/*Accept the Quadrature Receive Coil 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(0x0018,0x9044, enumQuadratureReceiveCoil.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9044,DicomConstants.DCM_DT_CS, enumQuadratureReceiveCoil.getValue());

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Indicates whether the receive coil is quadrature.
	 * @return String - value for The axes of the in-plane phase encoding with respect to the frame.
	 */
	public String getQuadratureReceiveCoil()
	{
		Object objValue = getValue(0x0018,0x9044);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Retrieves pre-initialized object of MultiCoilDefinitionSequence.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 MultiCoilDefinitionSequence - instance of Measurement Units Code Sequence. 
	 */
	public MultiCoilDefinitionSequence getMultiCoilDefinitionSequence()
	{
		MultiCoilDefinitionSequence objMultiCoilDefinitionSequence = null;
		IDataElement objIDataElement =  getDataForTag(0x0018,0x9045);
		if(objIDataElement != null)
		{
			IDicomValue objIDicomValue = objIDataElement.getDicomValue();
			if(objIDicomValue != null)
				objMultiCoilDefinitionSequence = (MultiCoilDefinitionSequence)objIDicomValue;
		}
		else
		{
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			int iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
			objIDataElement = null;
			objMultiCoilDefinitionSequence = (MultiCoilDefinitionSequence)objDicomV3Factory.createSequence(0x0018,0x9045, objITransferSyntax, objIDictionaryReader);

			if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)
				objIDataElement = new ImplicitDE(0x0018,0x9045, objMultiCoilDefinitionSequence.getValue(),objIDictionaryReader);
			else
				objIDataElement = new ExplicitDE(0x0018,0x9045, DicomConstants.DCM_DT_SQ, objMultiCoilDefinitionSequence.getValue());
			objIDataElement.setTransferSyntax(objITransferSyntax);
			if(objIDataElement != null)
				addDataElement(objIDataElement);
		}
		return objMultiCoilDefinitionSequence;
	}
	
	/**
	 * Sets A textual description of the configuration of multi-coil elements which was used in the current acquisition.
	 * @param StrMultiCoilConfiguration String identifies Organization
	 */	
	public void setMultiCoilConfiguration(String StrMultiCoilConfiguration)
	{
		/*Accept Multi-Coil Configuration in String format of type LO.
		 * Read the Transfer Syntax and check to create ImplicitDE or ExplicitDE .
		 * Set the iGroupNumber and iElementNumber to ImplicitDE object 
		 * Set the iVRType
		 * Set length from the element
		 * Add this element to the Hash Map
		 */
		IDataElement objIDataElement = null;
		if(objITransferSyntax.getVRTransferSyntax() == DicomConstants.DCM_VR_IMPLICIT)
			objIDataElement = new ImplicitDE(0x0018,0x9046,StrMultiCoilConfiguration,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9046, DicomConstants.DCM_DT_LO,StrMultiCoilConfiguration);
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves A textual description of the configuration of multi-coil elements which was used in the current acquisition.
	 * @return String - identifies the Organization
	 */
	public String getMultiCoilConfiguration()
	{
		Object objValue = getValue(0x0018,0x9046);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
