/*******************************************************************************
 *  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.TreatmentSessionIonBeamSequence;
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.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidItemException;
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 RT Ion Beams Session Record Module.
 */
public class RTIonBeamsSessionRecordModule extends Module  
{


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



	/**
	 * Instantiates a new rT general plan module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public RTIonBeamsSessionRecordModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

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

	/**
	 * 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,0x00B3))
				throw new MandatoryMissingException("300A,0x00B3");
			if(!isPresent(0x300A,0x0021))
				throw new MandatoryMissingException("300A,0021");
		
		}catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		catch(ConditionFailedException cfe)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(cfe.getMessage());

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

		}
		catch(InvalidItemException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(iie.getMessage());

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

		}
		return true;
	}
	/**
	 * Sets Referenced Fraction Group Number.
	 * Identifier of fraction group within referenced RT Ion Plan.
	 * @param strReferencedFractionGroupNumber String value of Number Of Copies.
	 */
	public void setReferencedFractionGroupNumber(String strReferencedFractionGroupNumber)
	{
		/* Accept ReferencedFractionGroupNumber 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 Hash Map
		 */
		addDataElement(0x300C,0x0022, DicomConstants.DCM_DT_IS,strReferencedFractionGroupNumber);
	}

	/**
	 * Return Referenced Fraction Group Number.
	 * 
	 * @return String - String value of Referenced Fraction Group Number.
	 */
	public String getReferencedFractionGroupNumber()
	{
		Object objValue = getValue(0x300C,0x0022);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets Number Of Fractions Planned.
	 * Identifier of fraction group within referenced RT Ion Plan.
	 * @param strNumberOfFractionsPlanned String value of Number Of Copies.
	 */
	public void setNumberOfFractionsPlanned(String strNumberOfFractionsPlanned)
	{
		/* Accept NumberOfFractionsPlanned 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 Hash Map
		 */
		addDataElement(0x300A,0x0078, DicomConstants.DCM_DT_IS,strNumberOfFractionsPlanned);
	}

	/**
	 * Return Number Of Fractions Planned.
	 * 
	 * @return String - String value of Number Of Fractions Planned.
	 */
	public String getNumberOfFractionsPlanned()
	{
		Object objValue = getValue(0x300A,0x0078);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * Sets PrimaryDosimeterUnit.
	 * Measurement unit of the machine dosimeter.
	 * Enumerated Values:
	 * 1) MU Monitor Units
	 * 2 )NP Number of Particles
	 * @param enumPrimaryDosimeterUnit the enum approval status
	 */
	public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit  enumPrimaryDosimeterUnit)
	{
		/* Accept PrimaryDosimeterUnit 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 PrimaryDosimeterUnit.
	 * 
	 * @return String - String value of PrimaryDosimeterUnit.
	 */ 
	public String getPrimaryDosimeterUnit()
	{
		Object objValue = getValue(0x300A,0x00B3);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	/**
	 * This method provides the pre-initialized object of Treatment Session Ion BeamSequence.
	 * 
	 * @return - object of Treatment Session Ion BeamSequence. 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
	 */
	public TreatmentSessionIonBeamSequence getReferencedVisitSequence()
	{
		TreatmentSessionIonBeamSequence objTreatmentSessionIonBeamSequence = (TreatmentSessionIonBeamSequence)getDicomValue(0x300A,0x0021);
		if(objTreatmentSessionIonBeamSequence == 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();
			objTreatmentSessionIonBeamSequence = (TreatmentSessionIonBeamSequence)objDicomV3Factory.createSequence(0x300A,0x0021, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x300A,0x0021, DicomConstants.DCM_DT_SQ, objTreatmentSessionIonBeamSequence.getValue());
		}
		return objTreatmentSessionIonBeamSequence;
	}
}
