/*******************************************************************************
 *  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.SpecimenMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.SurfaceSequence;
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;
//TODO: Auto-generated Javadoc
/**
\* This module specifies the Attributes that describe Surface Mesh Module.
*/
public class SurfaceMeshModule extends Module
{

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

	/**
	 * The obj Specimen Macro.
	 */
	SpecimenMacro objSpecimenMacro = null ;

	/**
	 * Instantiates a new Surface Mesh Module
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public SurfaceMeshModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
	}
	public boolean validateModule() throws InvalidModuleException 
	{

		try
		{
			if(!isPresent(0x0066, 0x0001))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0066,0001");
			}
			if(!isPresent(0x0066, 0x0002))
			{
				throw new MandatoryMissingException("Missing Mandatory DataElement 0066,0002");
			}
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets Number of surfaces contained in the Instance.
	 * @param iNumberOfSurfaces int value of Number of surfaces contained in the Instance.
	 */
	public void setNumberOfSurfaces(int iNumberOfSurfaces)
	{
		/* Accept the Offset Of Next Directory Record of type UL.
		 * 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(0x0066, 0x0001,DicomConstants.DCM_DT_UL,iNumberOfSurfaces);
	}
	/**
	 * Retrieves Number of surfaces contained in the Instance.
	 * @return int - value of Number of surfaces contained in the Instance.
	 */
	public int getNumberOfSurfaces()
	{
		Object objValue = getValue(0x0004,0x1400);
		if(objValue != null)
			return Integer.parseInt(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Retrieves pre-initialized object of SurfaceSequence. 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 SurfaceSequence 
	 */
	public SurfaceSequence getSurfaceSequence()
	{
		SurfaceSequence objSurfaceSequence= (SurfaceSequence)getDicomValue(0x0066, 0x0002);
		if(objSurfaceSequence == 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();
			objSurfaceSequence = (SurfaceSequence)objDicomV3Factory.createSequence(0x0066, 0x0002, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0066, 0x0002, DicomConstants.DCM_DT_SQ, objSurfaceSequence.getValue());
		}
		return objSurfaceSequence;
	}
	/*
	 * This method is used by the Module Iterator to iterate through the DataSet and return only
	 * those elements that belong to the respective Module class whose this is called.
	 */
	/**
	 * This method returns the collection of keys representing the DataElements
	 * that belong to this module.
	 * 
	 * @return ISingleCollection - the customized collection containing the dataelement tags
	 * that beling to this module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}

}
