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




/**
 * A sequence of devices used for patient alignment in Patient Setup.
 */

public class SetupDeviceSequenceItem extends Item  
{
	

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

	/**
	 * This constructor creates the item and internal code sequence macro with default TransferSyntax 
	 */
	SetupDeviceSequenceItem()
	{
		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 code sequence macro with default TransferSyntax 
	 * and default DictionaryReader.
	 * @param objITransferSyntax specifies the DICOM Standard defined TransfeSyntax.
	 */
	SetupDeviceSequenceItem(ITransferSyntax objITransferSyntax)
	{
		super(objITransferSyntax);
	}

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

	/**
	 * Validates all the attributes in {@link SetupDeviceSequence} 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(0x300A,0x01B6))
				throw new MandatoryMissingException("300A,01B6");
			if(!contains(0x300A,0x01B8))
				throw new MandatoryMissingException("300A,01B8");
			if(!contains(0x300A,0x01BC))
				throw new MandatoryMissingException("300A,01BC");

		}
		catch(MandatoryMissingException me)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(me.getMessage());
			}
			throw new ValidationException(this.getClass().getSimpleName(),me);
		}
		return true;
	}

	/**
	 * Sets type of setup device used for Patient alignment. Required if Setup Device
	 * Sequence (300A,01B4) is sent.
	 * Defined Terms:
	 * 1) LASER_POINTER.
	 * 2) DISTANCE_METER.
	 * 3) TABLE_HEIGHT
	 * 4) MECHANICAL_PTR.
	 * 5) ARC.
	 * @param enumSetupDeviceType enum value of Setup Device Type.
	 */
	public void setSetupDeviceType(EnumSetupDeviceType enumSetupDeviceType)
	{
		/* Accept the Setup Device 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(0x300A,0x01B6, enumSetupDeviceType.getValue(),getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x01B6,DicomConstants.DCM_DT_CS, enumSetupDeviceType.getValue());

		addDataElement(objIDataElement);


	}

	/**
	 * Return type of setup device used for Patient alignment. 
	 * @return String - value of Setup Device Type.
	 */
	public String getSetupDeviceType()
	{
		Object objValue = getValue(0x300A,0x01B6);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


	/**
	 * Sets user-defined label for Setup Device used for patient alignment.
	 * @param strSetupDeviceLabel String value of Setup Device Label.
	 */
	public void setSetupDeviceLabel(String strSetupDeviceLabel)
	{
		/* Accept the Setup Device Label 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(0x300A,0x01B8, strSetupDeviceLabel,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x01B8,DicomConstants.DCM_DT_SH, strSetupDeviceLabel);

		addDataElement(objIDataElement);


	}

	/**
	 * Return user-defined label for Setup Device used for patient alignment.
	 * @return String - value of Setup Device Label.
	 */
	public String getSetupDeviceLabel()
	{
		Object objValue = getValue(0x300A,0x01B8);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets user-defined description of Setup Device.
	 * @param strSetupDeviceDescription String value of Setup Device Description.
	 */
	public void setSetupDeviceDescription(String strSetupDeviceDescription)
	{
		/* Accept the Setup Device Description in String format of type ST.
		 * 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(0x300A,0x01BA, strSetupDeviceDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x01BA,DicomConstants.DCM_DT_ST, strSetupDeviceDescription);

		addDataElement(objIDataElement);


	}

	/**
	 * Return user-defined description of Setup Device.
	 * @return String - value of Setup Device Description.
	 */
	public String getSetupDeviceDescription()
	{
		Object objValue = getValue(0x300A,0x01BA);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system.
	 * Units shall be mm for distances and angles for degrees.
	 * @param strSetupDeviceParameter String value of Setup Device Parameter.
	 */
	public void setSetupDeviceParameter(String strSetupDeviceParameter)
	{
		/* Accept the Setup Device Parameter 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(0x300A,0x01BC, strSetupDeviceParameter,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x01BC,DicomConstants.DCM_DT_DS, strSetupDeviceParameter);

		addDataElement(objIDataElement);


	}

	/**
	 * Return Setup Parameter for Setup Device in appropriate IEC 61217 coordinate system.
	 * Units shall be mm for distances and angles for degrees.
	 * @return String - value of Setup Device Parameter.
	 */
	public String getSetupDeviceParameter()
	{
		Object objValue = getValue(0x300A,0x01BC);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets user-defined description of Setup Reference used for patient alignment.
	 * @param strSetupReferenceDescription String value of Setup Reference Description.
	 */
	public void setSetupReferenceDescription(String strSetupReferenceDescription)
	{
		/* Accept the Setup Reference Description in String format of type ST.
		 * 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
		 */
		int iVRTransferSyntax=0;
		IDataElement objIDataElement = null;

		if(objITransferSyntax != null)
			iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
		else
		{
			//Transfer Syntax not set
		}

		if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x300A,0x01D0, strSetupReferenceDescription,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x01D0,DicomConstants.DCM_DT_ST, strSetupReferenceDescription);

		addDataElement(objIDataElement);


	}

	/**
	 * Return user-defined description of Setup Reference used for patient alignment.
	 * @return String - value of Setup Reference Description.
	 */
	public String getSetupReferenceDescription()
	{
		Object objValue = getValue(0x300A,0x01D0);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Accessory Code.
	 * @param strAccessoryCode String value of Accessory Code.
	 */
	public void setAccessoryCode(String strAccessoryCode)
	{
		/* Accept the Accessory Code in String format of type LO.
		 * 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
		 */
		int iVRTransferSyntax=0;
		IDataElement objIDataElement = null;

		if(objITransferSyntax != null)
			iVRTransferSyntax = objITransferSyntax.getVRTransferSyntax();
		else
		{
			//Transfer Syntax not set
		}

		if(iVRTransferSyntax == DicomConstants.DCM_VR_IMPLICIT)	
			objIDataElement = new ImplicitDE(0x300A,0x00F9, strAccessoryCode,getDictionaryReader());
		else
			objIDataElement = new ExplicitDE(0x300A,0x00F9,DicomConstants.DCM_DT_LO, strAccessoryCode);

		addDataElement(objIDataElement);


	}

	/**
	 * Return Accessory Code.
	 * @return String - value of Accessory Code.
	 */
	public String getAccessoryCode()
	{
		Object objValue = getValue(0x300A,0x00F9);
		if(objValue != null)
			return objValue.toString();
		return null;
	}


}
