/*******************************************************************************
 *  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.utils.DicomConstants;
/**
* This item class contains methods to validate, set and get attributes in {@link MRTransmitCoilSequence}. 
*/
public class MRTransmitCoilSequenceItem extends Item
{
	

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

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

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

	/**
	 * Validates all the attributes in MediaInstalledSequenceItem that are present in the DataSet
	 * @return boolean - Success -true, Failure - false
	 * @throws InvalidItemException throws InvalidItemException Conditional element fails.
	 */
	public boolean validateForModule()  throws InvalidItemException
	{
		/*
		 * 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 :- 617
		 */
		return true;
	}

	/**
	 * Sets Name of transmit coil used.
	 * @param strTransmitCoilName String value of Template Type.
	 */
	public void setTransmitCoilName(String strTransmitCoilName)
	{
		/*Accept the TransmitCoilName 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,0x1251, strTransmitCoilName,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x1251,DicomConstants.DCM_DT_SH, strTransmitCoilName);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Name of transmit coil used.
	 * @return String - value of Name of transmit coil used..
	 */
	public String getTransmitCoilName()
	{
		Object objValue = getValue(0x0018,0x1251);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Name of manufacturer of transmit coil.
	 * @param StrTransmitCoilManufacturerName String identifies Organization
	 */	
	public void setTransmitCoilManufacturerName(String StrTransmitCoilManufacturerName)
	{
		/*Accept Transmit 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,0x9050,StrTransmitCoilManufacturerName,objIDictionaryReader);
		else
			objIDataElement = new ExplicitDE(0x0018,0x9050, DicomConstants.DCM_DT_LO,StrTransmitCoilManufacturerName);
		addDataElement(objIDataElement);
	}

	/**
	 * Retrieves Name of manufacturer of transmit coil.
	 * @return String -  value of Name of manufacturer of transmit coil.
	 */
	public String getTransmitCoilManufacturerName()
	{
		Object objValue = getValue(0x0018,0x9050);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets the Type of transmit coil used.
	 * @param strTransmitCoilType Specifies type of the value encoded in this Item
	 */
	public void setTransmitCoilType(String strTransmitCoilType)
	{
		/*Accept the Transmit 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,0x9051, strTransmitCoilType,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x0018,0x9051,DicomConstants.DCM_DT_CS, strTransmitCoilType);

		addDataElement(objIDataElement);
	}
	/**
	 * Retrieves Type of transmit coil used.
	 * @return String - Type of the value Type of transmit coil used.
	 */
	public String getTransmitCoilType()
	{
		Object objValue = getValue(0x0018,0x9051);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
}
