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

import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.RegistrationMethodCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.SurfaceScanAcquisitionTypeCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.SurfaceScanModeCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;

import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
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;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;
/**
 \* This module specifies the attributes of Scan Procedure Module.
 */
public class ScanProcedureModule extends Module
{
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * Creates ScanProcedureModule
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public ScanProcedureModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}



	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0080, 0x0001));
		objSingleCollection.add(new Tag(0x0080, 0x0002));
		objSingleCollection.add(new Tag(0x0080, 0x0003));
		objSingleCollection.add(new Tag(0x0020, 0x0013));
		objSingleCollection.add(new Tag(0x0020, 0x0012));
		objSingleCollection.add(new Tag(0x0008, 0x002A));
		objSingleCollection.add(new Tag(0x0080, 0x0004));
		objSingleCollection.add(new Tag(0x0080, 0x0005));
	}

	/**
	 * This method validates each Attribute in the Module according to the Type
	 * of the Attribute.Attributes are of 5 types.
	 * Type 1,Type 2 are Mandatory:
	 * Mandatory Attributes have to present in the Module.
	 * Type 1C,2C are Conditional:
	 * Conditional Attributes' presence depend on a condition.
	 * If the condition is satisfied the Attribute has to be present.
	 * Type 3 are Optional
	 * Optional Attributes can be added as and when required.
	 * 
	 * @return boolean - returns validation status as success or failure
	 * 
	 * @throws InvalidModuleException If validation of Module fails
	 */
	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{
			if(!isPresent(0x0080, 0x0001))
				throw new MandatoryMissingException("0080,0001");
			if(!isPresent(0x0080, 0x0002))
				throw new MandatoryMissingException("0080,0002");
			if(!isPresent(0x0020, 0x0013))
				throw new MandatoryMissingException("0020,0013");
			if(!isPresent(0x0020, 0x0012))
				throw new MandatoryMissingException("0020,0012");
			if(!isPresent(0x0008, 0x002A))
				throw new MandatoryMissingException("0008,002A");
			if(!isPresent(0x0080, 0x0004))
				throw new MandatoryMissingException("0080,0004");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

			
				throw new InvalidModuleException(this.getClass().getSimpleName(),mme);

		}
		return true;
	}
	/**
	 * Retrieves pre-initialized object of Surface Scan Acquisition TypeCode Sequence.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 SurfaceScanAcquisitionTypeCodeSequence - instance of Surface Scan Acquisition TypeCode Sequence.
	 */
	public SurfaceScanAcquisitionTypeCodeSequence getSurfaceScanAcquisitionTypeCodeSequence()
	{
		SurfaceScanAcquisitionTypeCodeSequence objSurfaceScanAcquisitionTypeCodeSequence= (SurfaceScanAcquisitionTypeCodeSequence)getDicomValue(0x0080, 0x0001);
		if(objSurfaceScanAcquisitionTypeCodeSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objSurfaceScanAcquisitionTypeCodeSequence = (SurfaceScanAcquisitionTypeCodeSequence)objDicomV3Factory.createSequence(0x0080, 0x0001, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0080, 0x0001, DicomConstants.DCM_DT_SQ, objSurfaceScanAcquisitionTypeCodeSequence.getValue());
		}
		return objSurfaceScanAcquisitionTypeCodeSequence;
	}
	/**
	 * Retrieves pre-initialized object of Surface Scan Mode CodeSequence.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 SurfaceScanModeCodeSequence - instance of Surface Scan Mode CodeSequence.
	 */
	public SurfaceScanModeCodeSequence getSurfaceScanModeCodeSequence()
	{
		SurfaceScanModeCodeSequence objSurfaceScanModeCodeSequence= (SurfaceScanModeCodeSequence)getDicomValue(0x0080, 0x0002);
		if(objSurfaceScanModeCodeSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objSurfaceScanModeCodeSequence = (SurfaceScanModeCodeSequence)objDicomV3Factory.createSequence(0x0080, 0x0002, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0080, 0x0002, DicomConstants.DCM_DT_SQ, objSurfaceScanModeCodeSequence.getValue());
		}
		return objSurfaceScanModeCodeSequence;
	}
	/**
	 * Retrieves pre-initialized object of Registration Method CodeSequence.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 RegistrationMethodCodeSequence - instance of Registration Method CodeSequence
	 */
	public RegistrationMethodCodeSequence getRegistrationMethodCodeSequence()
	{
		RegistrationMethodCodeSequence objRegistrationMethodCodeSequence= (RegistrationMethodCodeSequence)getDicomValue(0x0080, 0x0003);
		if(objRegistrationMethodCodeSequence == null)
		{
			/*
			 * If the sequence object is not present in the DataSet, a new sequence object is created and
			 * the TransferSyntax and DictionaryReader is set into it as it is set in the Module. This ensures that 
			 * the DataElements getting added in the DataSet follow the same TransferSyntax and use the same
			 * DictionaryReader object as that of the module.
			 */
			DicomV3Factory objDicomV3Factory = DicomV3Factory.createInstance();
			objRegistrationMethodCodeSequence = (RegistrationMethodCodeSequence)objDicomV3Factory.createSequence(0x0080, 0x0003, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0080, 0x0003, DicomConstants.DCM_DT_SQ, objRegistrationMethodCodeSequence.getValue());
		}
		return objRegistrationMethodCodeSequence;
	}
	/**
	 * Sets A number that identifies this instance.
	 * 
	 * @param strInstanceNumber - A number that identifies this instance.
	 */	
	public void setInstanceNumber(String strInstanceNumber)
	{
		/* Accept Instance Numberin String format of type IS.
		 * 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
		 */
		addDataElement(0x0020, 0x0013, DicomConstants.DCM_DT_IS, strInstanceNumber);
	}

	/**
	 * Retrieves A number that identifies this instance.
	 * 
	 * @return - String value of Instance Number.
	 */
	public String getInstanceNumber()
	{
		Object objectValue = getValue(0x0020,0x0013);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	/**
	 * Sets Acquisition Number
	 * 
	 * @param strAcquisitionNumber - Acquisition Number.
	 */	
	public void setAcquisitionNumber(String strAcquisitionNumber)
	{
		/* Accept Acquisition Number in String format of type IS.
		 * 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
		 */
		addDataElement(0x0020, 0x0012, DicomConstants.DCM_DT_IS, strAcquisitionNumber);
	}

	/**
	 * Retrieves Acquisition Number.
	 * 
	 * @return - String value of AcquisitionNumber.
	 */
	public String getAcquisitionNumber()
	{
		Object objectValue = getValue(0x0020,0x0012);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	/**
	 * Sets date and time that the acquisition of data that resulted in this instance started.
	 * @param strAcquisitionDateTime String value of Acquisition DateTime
	 */
	public void setAcquisitionDateTime(String strAcquisitionDateTime)
	{
		/* Accept the Acquisition DateTime of type DT.
		 * 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
		 */
		addDataElement(0x0008, 0x002A, DicomConstants.DCM_DT_DT,strAcquisitionDateTime);
	}

	/**
	 * Retrieves date and time that the acquisition of data that resulted in this instance started.
	 * @return String - value of Acquisition DateTime
	 */
	public String getAcquisitionDateTime()
	{
		Object objValue = getValue(0x0008, 0x002A);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets the time in seconds from the start of this shot until the endof this shot.
	 * @param dblShotDurationTime Double value of Shot Duration Time
	 */
	public void setShotDurationTime(double dblShotDurationTime)
	{
		/*Accept the Shot Duration Time 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
		 */
		addDataElement(0x0080, 0x0004, DicomConstants.DCM_DT_FD,dblShotDurationTime);
	}
	/**
	 * Retrieves the time in seconds from the start of this shot until the endof this shot.
	 * @return double - double value of Shot Duration Time
	 */
	public double getShotDurationTime()
	{
		Object objValue = getValue(0x0080, 0x0004);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * Sets the time in seconds from the start of this shot until the start of this shot.
	 * @param dblShotOffsetTime Double value of ShotOffsetTime
	 */
	public void setShotOffsetTime(double dblShotOffsetTime)
	{
		/*Accept the ShotOffsetTime 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
		 */
		addDataElement(0x0080, 0x0005, DicomConstants.DCM_DT_FD,dblShotOffsetTime);
	}
	/**
	 * Retrieves the time in seconds from the start of this shot until the start of this shot.
	 * @return double - double value of ShotOffsetTime
	 */
	public double getShotOffsetTime()
	{
		Object objValue = getValue(0x0080, 0x0005);
		if(objValue != null)
			return Double.parseDouble(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	/**
	 * This method returns the vector of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return vector of Tags - returns the vector containing the collection of tags.
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
