/*******************************************************************************
 *  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.Tag;
import cdac.medinfo.sdk.dcm30_04.baselibs.TreatmentSessionBeamSequence;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumPrimaryDosimeterUnit;

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
/**
 \* This module specifies attributes for RT Beams Session Record Module.
 */

public class RTBeamsSessionRecordModule extends Module  
{


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


	/**
	 * Instantiates a new rT beams session record module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public RTBeamsSessionRecordModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x1070));
		objSingleCollection.add(new Tag(0x3008,0x0020));
		objSingleCollection.add(new Tag(0x300A,0x0078));
		objSingleCollection.add(new Tag(0x300A,0x00B3));
		objSingleCollection.add(new Tag(0x300C,0x0022));
	}

	/**
	 * 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(0x0008, 0x1070))
				throw new MandatoryMissingException("0008,1070");
			if(!isPresent(0x300A, 0x0078))
				throw new MandatoryMissingException("300A,0078");
			if(!isPresent(0x300A, 0x00B3))
				throw new MandatoryMissingException("300A,00B3");
			if(!isPresent(0x3008, 0x0020))
				throw new MandatoryMissingException("3008,0020");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets the name of operator administering treatment session.
	 * 
	 * @param arrStrOperatorNames - String array of Name(s) of the operator(s).
	 */	
	public void setOperatorNames(String[] arrStrOperatorNames)
	{
		/*Accept the Operator Names value in String Array format of type PN.
		 * 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
		 */
		addDataElement(0x0008, 0x1070, DicomConstants.DCM_DT_PN, arrStrOperatorNames);
	}

	/**
	 * Retrieves the name of operator administering treatment session.
	 * 
	 * @return  arrStrOperatorNames - String value of Name(s) of the operator(s).
	 */
	public String[] getOperatorNames()
	{
		 Object objValue = getValue(0x0008,0x1070);
   if(objValue!=null)
      return (String[])objValue;
   return null;

	}

	/**
	 * Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan
	 * Sequence (300C,0002).
	 * 
	 * @param strReferencedFractionGroupNumber - String value of Referenced Fraction Group Number.
	 */
	public void setReferencedFractionGroupNumber(String strReferencedFractionGroupNumber)
	{
		/* Accept Referenced Fraction Group 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(0x300C, 0x0022, DicomConstants.DCM_DT_IS, strReferencedFractionGroupNumber);
	}

	/**
	 * Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan
	 * Sequence (300C,0002).
	 * 
	 * @return the referenced fraction group number
	 */
	public String getReferencedFractionGroupNumber()
	{
		 Object objValue = getValue(0x300C,0x0022);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/**
	 * Sets total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @param strNumberOfFractionsPlanned - String value of Number of Fractions Planned.
	 */
	public void setNumberOfFractionsPlanned(String strNumberOfFractionsPlanned)
	{
		/* Accept Number of Fractions Planned 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(0x300A, 0x0078, DicomConstants.DCM_DT_IS, strNumberOfFractionsPlanned);
	}

	/**
	 * Retrieves total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @return the number of fractions planned
	 */
	public String getNumberOfFractionsPlanned()
	{
		 Object objValue = getValue(0x300A,0x0078);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}


	/**
	 * Sets total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @param enumPrimaryDosimeterUnit - Enum value of Primary Dosimeter Unit.
	 */
	public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)
	{
		/* Accept Primary Dosimeter Unit 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, 0x00B3, DicomConstants.DCM_DT_CS, enumPrimaryDosimeterUnit.getValue());
	}

	/**
	 * Retrieves total number of treatments (Fractions) planned for current Fraction Group.
	 * 
	 * @return the primary dosimeter unit
	 */
	public String getPrimaryDosimeterUnit()
	{
		 Object objValue = getValue(0x300A,0x00B3);
   if(objValue!=null)
      return objValue.toString();
   return null;

	}

	/**
	 * Retrieves sequence of Beams administered during treatment session.
	 * 
	 * @return - instance of {@link TreatmentSessionBeamSequence}.
	 */
	public TreatmentSessionBeamSequence getTreatmentSessionBeamSequence()
	{
		TreatmentSessionBeamSequence objTreatmentSessionBeamSequence = (TreatmentSessionBeamSequence)getDicomValue(0x3008, 0x0020);
		if(objTreatmentSessionBeamSequence == 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();
			objTreatmentSessionBeamSequence = (TreatmentSessionBeamSequence)objDicomV3Factory.createSequence(0x3008, 0x0020, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x3008, 0x0020, DicomConstants.DCM_DT_SQ, objTreatmentSessionBeamSequence.getValue());
		}
		return objTreatmentSessionBeamSequence;
	}

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