/*******************************************************************************
 *  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.ApplicationSetupSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.SourceSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentMachineSequence;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBrachyTreatmentTechnique;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBrachyTreatmentType;

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;

// TODO: Auto-generated Javadoc
/**
 * The RT Brachy Application Setups Module describes the application of a brachytherapy radiotherapy treatment.
 */

public class RTBrachyApplicationSetupsModule extends Module  
{


	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;


	/**
	 * Instantiates a new rT brachy application setups module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public RTBrachyApplicationSetupsModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x300A,0x0200));
		objSingleCollection.add(new Tag(0x300A,0x0202));
		objSingleCollection.add(new Tag(0x300A,0x0206));
		objSingleCollection.add(new Tag(0x300A,0x0210));
		objSingleCollection.add(new Tag(0x300A,0x0230));
	}

	/**
	 * 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(0x300A,0x0200))
				throw new MandatoryMissingException("300A,0200");
			if(!isPresent(0x300A,0x0202))
				throw new MandatoryMissingException("300A,0202");
			if(!isPresent(0x300A,0x0206))
				throw new MandatoryMissingException("300A,0206");
			else
				getTreatmentMachineSequence().validateForModule();
			if(!isPresent(0x300A,0x0210))
				throw new MandatoryMissingException("300A,0210");
			else
				getSourceSequence().validateForModule();
			if(!isPresent(0x300A,0x0230))
				throw new MandatoryMissingException("300A,0230");
			else
				getApplicationSetupSequence().validateForModule();
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}


	/**
	 * Sets type of brachytherapy treatment technique.
	 * 
	 * @param enumBrachyTreatmentTechnique - Enum value of Brachy Treatment Technique.
	 */
	public void setBrachyTreatmentTechnique(EnumBrachyTreatmentTechnique enumBrachyTreatmentTechnique)
	{
		/* Accept Structure Set Label 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
		 */
		addDataElement(0x300A,0x0200, DicomConstants.DCM_DT_CS, enumBrachyTreatmentTechnique.getValue());
	}

	/**
	 * Retrieves brachytherapy treatment technique.
	 * 
	 * @return the brachy treatment technique
	 */
	public String getBrachyTreatmentTechnique()
	{
		 Object objValue = getValue(0x300A,0x0200);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}


	/**
	 * Sets type of brachytherapy treatment..
	 * 
	 * @param enumBrachyTreatmentType - Enum value of Brachy Treatment Type.
	 */
	public void setBrachyTreatmentType(EnumBrachyTreatmentType enumBrachyTreatmentType)
	{
		/* Accept Structure Set Label 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
		 */
		addDataElement(0x300A,0x0202, DicomConstants.DCM_DT_CS, enumBrachyTreatmentType.getValue());
	}

	/**
	 * Retrieves brachytherapy treatment type.
	 * 
	 * @return the brachy treatment type
	 */
	public String getBrachyTreatmentType()
	{
		 Object objValue = getValue(0x300A,0x0202);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}


	/**
	 * Retrieves sequence of items describing  Frames of Reference in which the ROIs are defined.
	 * 
	 * @return - instance of {@link TreatmentMachineSequence}.
	 */
	public TreatmentMachineSequence getTreatmentMachineSequence()
	{
		TreatmentMachineSequence objTreatmentMachineSequence = (TreatmentMachineSequence)getDicomValue(0x300A,0x0206);
		if(objTreatmentMachineSequence == 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();
			objTreatmentMachineSequence = (TreatmentMachineSequence)objDicomV3Factory.createSequence(0x300A,0x0206, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300A,0x0206, DicomConstants.DCM_DT_SQ, objTreatmentMachineSequence.getValue());
		}
		return objTreatmentMachineSequence;
	}


	/**
	 * Retrieves sequence of items describing  Frames of Reference in which the ROIs are defined.
	 * 
	 * @return - instance of {@link SourceSequence}.
	 */
	public SourceSequence getSourceSequence()
	{
		SourceSequence objSourceSequence = (SourceSequence)getDicomValue(0x300A,0x0210);
		if(objSourceSequence == 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();
			objSourceSequence = (SourceSequence)objDicomV3Factory.createSequence(0x300A,0x0210, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300A,0x0210, DicomConstants.DCM_DT_SQ, objSourceSequence.getValue());
		}
		return objSourceSequence;
	}


	/**
	 * Retrieves sequence of items describing  Frames of Reference in which the ROIs are defined.
	 * 
	 * @return - instance of {@link ApplicationSetupSequence}.
	 */
	public ApplicationSetupSequence getApplicationSetupSequence()
	{
		ApplicationSetupSequence objApplicationSetupSequence = (ApplicationSetupSequence)getDicomValue(0x300A,0x0230);
		if(objApplicationSetupSequence == 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();
			objApplicationSetupSequence = (ApplicationSetupSequence)objDicomV3Factory.createSequence(0x300A,0x0230, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300A,0x0230, DicomConstants.DCM_DT_SQ, objApplicationSetupSequence.getValue());
		}
		return objApplicationSetupSequence;
	}

	/**
	 * 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;
	}
}
