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

import java.io.IOException;
import java.util.Locale;


import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDicomStream;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDictionaryReader;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITransferSyntax;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CineModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CommonInstanceReferenceModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DeviceModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FrameExtractionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FrameOfReferenceModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FramePointersModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralEquipmentModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralImageModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageIOD;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImagePixelModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameDimensionModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameFunctionalGroupsModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCEquipmentModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCImageModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCMultiFrameImageModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SCMultiFrameVectorModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SpecimenModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SynchronizationModule;
import cdac.medinfo.sdk.dcm30_04.dicommodel.modules.VOILUTModule;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBitsAllocated;
import cdac.medinfo.sdk.dcm30_04.enums.EnumBitsStored;
import cdac.medinfo.sdk.dcm30_04.enums.EnumHighBit;
import cdac.medinfo.sdk.dcm30_04.enums.EnumModuleNames;
import cdac.medinfo.sdk.dcm30_04.enums.EnumPhotometricInterpretation;
import cdac.medinfo.sdk.dcm30_04.enums.EnumPixelRepresentation;
import cdac.medinfo.sdk.dcm30_04.enums.EnumSOPClassUIDs;
import cdac.medinfo.sdk.dcm30_04.enums.EnumSamplesPerPixel;

import cdac.medinfo.sdk.dcm30_04.exceptions.ConditionFailedException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidIODException;
import cdac.medinfo.sdk.dcm30_04.exceptions.InvalidModuleException;
import cdac.medinfo.sdk.dcm30_04.exceptions.ParseException;
import cdac.medinfo.sdk.dcm30_04.utils.DicomConfig;
import cdac.medinfo.sdk.dcm30_04.utils.DicomLogger;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.ResourceBundleWrapper;

/**
 * The Multi-frame Grayscale Byte Secondary Capture (SC) Image Information Object Definition (IOD) specifies
 * Grayscale Byte images that are converted from a non-DICOM format to a modality independent DICOM format.
 * 
 * 
 */
public class MultiFrameGrayscaleByteSCImageIOD extends ImageIOD 
{
	

	/**
	 * The obj cine module.
	 */
	CineModule objCineModule = null;

	/**
	 * The obj frame pointers module.
	 */
	FramePointersModule objFramePointersModule = null; 

	/**
	 * The obj general image module.
	 */
	GeneralImageModule objGeneralImageModule = null; 

	/**
	 * The obj multi frame module.
	 */
	MultiFrameModule objMultiFrameModule = null; 
	
	/**
	 * The obj Frame Of Reference module.
	 */
	FrameOfReferenceModule objFrameOfReferenceModule = null; 
	
	/**
	 * The obj Multi Frame Functional Groups module.
	 */
	MultiFrameFunctionalGroupsModule objMultiFrameFunctionalGroupsModule = null; 
	
	/**
	 * The obj Multi Frame Dimension module.
	 */
	MultiFrameDimensionModule objMultiFrameDimensionModule = null; 

	/**
	 * The obj synchronization module.
	 */
	SynchronizationModule objSynchronizationModule = null;
	
	/**
	 * The obj Device module.
	 */
	DeviceModule objDeviceModule = null;
	
	/**
	 * The obj Specimen module.
	 */
	SpecimenModule objSpecimenModule = null;
	
	/**
	 * The obj sc image module.
	 */
	SCImageModule objSCImageModule = null; 

	/**
	 * The obj sc multi frame image module.
	 */
	SCMultiFrameImageModule objSCMultiFrameImageModule = null;

	/**
	 * The obj sc multi frame vector module.
	 */
	SCMultiFrameVectorModule objSCMultiFrameVectorModule = null;

	/**
	 * The obj sc equipment module.
	 */
	SCEquipmentModule objSCEquipmentModule = null;

	/**
	 * The obj sop common module.
	 */
	SOPCommonModule objSOPCommonModule = null;

	/**
	 * The obj Common Instance Reference module.
	 */
	CommonInstanceReferenceModule objCommonInstanceReferenceModule = null;
	
	/**
	 * The obj Frame Extraction module.
	 */
	FrameExtractionModule objFrameExtractionModule = null;

	/**
	 * The obj voilut module.
	 */
	VOILUTModule objVOILUTModule = null;

	/**
	 * The Constant MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD.
	 */
	public static final String MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD = "Multi-frame Grayscale Byte SC Image IOD";

	/**
	 * Instantiates a new multi frame grayscale byte sc image iod.
	 */
	public MultiFrameGrayscaleByteSCImageIOD()
	{
		super();
	}

	/**
	 * This constructor initializes the TransferSyntax  in its superclass IOD.
	 * 
	 * @param objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.
	 */
	public MultiFrameGrayscaleByteSCImageIOD(ITransferSyntax objITransferSyntax_)
	{
		super(objITransferSyntax_);
	}

	/**
	 * This constructor initializes the  DictionaryReader
	 * in its superclass IOD.
	 * 
	 * @param objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .
	 */
	public MultiFrameGrayscaleByteSCImageIOD(IDictionaryReader objIDictionaryReader_)
	{
		super(objIDictionaryReader_);
	}

	/**
	 * This constructor accepts the DataSet from the user   in its superclass IOD.
	 * 
	 * @param objIDataSet_ - specifies the data set to be set in the IOD.
	 */
	public MultiFrameGrayscaleByteSCImageIOD(IDataSet objIDataSet_)
	{
		super(objIDataSet_);
	}

	/**
	 * This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
	 * 
	 * @param objITransferSyntax_ specifies the DICOM Standard defined TransfeSyntax.
	 * @param objIDictionaryReader_ specifies the DICOM Dictionary reader to be used .
	 */
	public MultiFrameGrayscaleByteSCImageIOD(ITransferSyntax objITransferSyntax_,IDictionaryReader objIDictionaryReader_)
	{
		super(objITransferSyntax_,objIDictionaryReader_);
	}

	/**
	 * Creates MultiFrameGrayscaleByteSCImageIOD IOD from a DICOM file containing MultiFrameGrayscaleByteSCImageIOD DICOM data.
	 * @param strFileName DICOM File with absolute path.
	 * @throws IOException Exception caused due to wrong I/O operations. 
	 * @throws ParseException signals if some parse exceptions are occurred.
	 * @throws InvalidIODException signals if some IOD exceptions are occurred.
	 */
	public MultiFrameGrayscaleByteSCImageIOD(String strFileName)throws IOException,InvalidIODException
	{
		super(strFileName);
		try
		{
			if(objIDataSet != null)
			{
				String strSOPClassUID = objIDataSet.getSOPClassUID();
				if(strSOPClassUID != null)
				{
					if(!strSOPClassUID.equals(EnumSOPClassUIDs.MFGRAYSCALEBYTESCIOD.getValue()))
					{
						throw new InvalidIODException(ResourceBundleWrapper.getValue("exceptions", "InvalidIOD.FileNotMatched", new Locale(DicomConfig.createInstance().getLocale())) + MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD);
					}
				}
				strSOPClassUID = null;
			}
		}
		catch(InvalidIODException iie)
		{
			if(DicomConfig.createInstance().isLoggingOn())
			{
				DicomLogger.getLogger().log(iie.getMessage());
			}
			throw iie;
		}
	}

	/**
	 * Retrieves pre-initialized instance of SC Equipment Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SCEquipmentModule - instance of {@link SCEquipmentModule}.
	 */
	public SCEquipmentModule getSCEquipmentModule()
	{
		if(objSCEquipmentModule == null)
		{
			objSCEquipmentModule = new SCEquipmentModule(objIDataSet);
			return objSCEquipmentModule;
		}
		return objSCEquipmentModule;
	}

	/**
	 * Retrieves pre-initialized instance of General Image Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return GeneralImageModule - instance of {@link GeneralImageModule}.
	 */
	public GeneralImageModule  getGeneralImageModule ()
	{
		if(objGeneralImageModule  == null)
		{
			objGeneralImageModule = new GeneralImageModule (objIDataSet);
			return objGeneralImageModule;
		}
		return objGeneralImageModule;
	}

	/**
	 * Retrieves pre-initialized instance of Cine Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return CineModule - instance of {@link CineModule}.
	 */
	public CineModule  getCineModule()
	{
		if(objCineModule == null)
		{
			objCineModule = new CineModule(objIDataSet);
			return objCineModule;
		}
		return objCineModule;
	}

	/**
	 * Retrieves pre-initialized instance of Multi Frame Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return MultiFrameModule - instance of {@link MultiFrameModule}.
	 */
	public MultiFrameModule getMultiFrameModule()
	{
		if(objMultiFrameModule == null)
		{
			objMultiFrameModule = new MultiFrameModule(objIDataSet);
			return objMultiFrameModule;
		}
		return objMultiFrameModule;
	}

	/**
	 * Retrieves pre-initialized instance of Frame Pointers Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return FramePointersModule - instance of {@link FramePointersModule}.
	 */
	public FramePointersModule getFramePointersModule()
	{
		if(objFramePointersModule == null)
		{
			objFramePointersModule = new FramePointersModule(objIDataSet);
			return objFramePointersModule;
		}
		return objFramePointersModule;
	}

	/**
	 * Retrieves pre-initialized instance of Frame Of Reference Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return FrameOfReferenceModule - instance of {@link FrameOfReferenceModule}.
	 */
	public FrameOfReferenceModule getFrameOfReferenceModule()
	{
		if(objFrameOfReferenceModule == null)
		{
			objFrameOfReferenceModule = new FrameOfReferenceModule(objIDataSet);
			return objFrameOfReferenceModule;
		}
		return objFrameOfReferenceModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of MultiFrame Functional Groups Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return MultiFrameFunctionalGroupsModule - instance of {@link MultiFrameFunctionalGroupsModule}.
	 */
	public MultiFrameFunctionalGroupsModule getMultiFrameFunctionalGroupsModule()
	{
		if(objMultiFrameFunctionalGroupsModule == null)
		{
			objMultiFrameFunctionalGroupsModule = new MultiFrameFunctionalGroupsModule(objIDataSet);
			return objMultiFrameFunctionalGroupsModule;
		}
		return objMultiFrameFunctionalGroupsModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of MultiFrame Dimension Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return MultiFrameDimensionModule - instance of {@link MultiFrameDimensionModule}.
	 */
	public MultiFrameDimensionModule getMultiFrameDimensionModule()
	{
		if(objMultiFrameDimensionModule == null)
		{
			objMultiFrameDimensionModule = new MultiFrameDimensionModule(objIDataSet);
			return objMultiFrameDimensionModule;
		}
		return objMultiFrameDimensionModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Synchronization Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SynchronizationModule - instance of {@link SynchronizationModule}.
	 */
	public SynchronizationModule getSynchronizationModule()
	{
		if(objSynchronizationModule == null)
		{
			objSynchronizationModule = new SynchronizationModule(objIDataSet);
			return objSynchronizationModule;
		}
		return objSynchronizationModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Device Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return DeviceModule - instance of {@link DeviceModule}.
	 */
	public DeviceModule getDeviceModule()
	{
		if(objDeviceModule == null)
		{
			objDeviceModule = new DeviceModule(objIDataSet);
			return objDeviceModule;
		}
		return objDeviceModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Specimen Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SpecimenModule - instance of {@link SpecimenModule}.
	 */
	public SpecimenModule getSpecimenModule()
	{
		if(objSpecimenModule == null)
		{
			objSpecimenModule = new SpecimenModule(objIDataSet);
			return objSpecimenModule;
		}
		return objSpecimenModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of SC Image Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SCImageModule - instance of {@link SCImageModule}.
	 */
	public SCImageModule getSCImageModule()
	{
		if(objSCImageModule == null)
		{
			objSCImageModule = new SCImageModule(objIDataSet);
			return objSCImageModule;
		}
		return objSCImageModule;
	}

	/**
	 * Retrieves pre-initialized instance of SC Multi Frame Image Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SCMultiFrameImageModule - instance of {@link SCMultiFrameImageModule}.
	 */
	public SCMultiFrameImageModule getSCMultiFrameImageModule()
	{
		if(objSCMultiFrameImageModule == null)
		{
			objSCMultiFrameImageModule = new SCMultiFrameImageModule(objIDataSet);
			return objSCMultiFrameImageModule;
		}
		return objSCMultiFrameImageModule;
	}

	/**
	 * Retrieves pre-initialized instance of SC Multi Frame Vector Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SCMultiFrameVectorModule - instance of {@link SCMultiFrameVectorModule}.
	 */
	public SCMultiFrameVectorModule getSCMultiFrameVectorModule()
	{
		if(objSCMultiFrameVectorModule == null)
		{
			objSCMultiFrameVectorModule = new SCMultiFrameVectorModule(objIDataSet);
			return objSCMultiFrameVectorModule;
		}
		return objSCMultiFrameVectorModule;
	}

	/**
	 * Retrieves pre-initialized instance of VOI LUT Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return VOILUTModule - instance of {@link VOILUTModule}.
	 */
	public VOILUTModule getVOILUTModule()
	{
		if(objVOILUTModule == null)
		{
			objVOILUTModule = new VOILUTModule(objIDataSet);
			return objVOILUTModule;
		}
		return objVOILUTModule;
	}

	/**
	 * Retrieves pre-initialized instance of SOP Common Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return SOPCommonModule - instance of {@link SOPCommonModule}.
	 */
	public SOPCommonModule getSOPCommonModule()
	{
		if(objSOPCommonModule == null)
		{
			objSOPCommonModule = new SOPCommonModule(objIDataSet);
			return objSOPCommonModule;
		}
		return objSOPCommonModule;
	}

	/**
	 * Retrieves pre-initialized instance of Common Instance Reference Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return CommonInstanceReferenceModule - instance of {@link CommonInstanceReferenceModule}.
	 */
	public CommonInstanceReferenceModule getCommonInstanceReferenceModule()
	{
		if(objCommonInstanceReferenceModule == null)
		{
			objCommonInstanceReferenceModule = new CommonInstanceReferenceModule(objIDataSet);
			return objCommonInstanceReferenceModule;
		}
		return objCommonInstanceReferenceModule;
	}
	
	/**
	 * Retrieves pre-initialized instance of Frame Extraction Module. Creates a new instance
	 * if no pre-existing module instance is available.If previously created instance is
	 * present then returns the same module instance.
	 * 
	 * @return FrameExtractionModule - instance of {@link FrameExtractionModule}.
	 */
	public FrameExtractionModule getFrameExtractionModule()
	{
		if(objFrameExtractionModule == null)
		{
			objFrameExtractionModule = new FrameExtractionModule(objIDataSet);
			return objFrameExtractionModule;
		}
		return objFrameExtractionModule;
	}
	
	/**
	 * This method validates MultiFrame Grayscale Byte SC Image IOD according to the Module Table given in The DICOM Standard.
	 * The validate method fails if one of the mandatory modules are absent or any of the
	 * modules are invalid.The validate method also checks for conditional modules.
	 * 
	 * @return - function status indicating success or failure.
	 * 
	 * @throws InvalidIODException - this method will throw exception if IOD is invalid.
	 */
	public boolean validate() throws InvalidIODException
	{
		super.validate();

		try
		{
			/*
			 * This condition checks for Mandatory Modules validation of MultiFrame Grayscale Byte SC Image IOD.
			 */
			getSCEquipmentModule().validateModule();
			getGeneralImageModule().validateModule();
			getMultiFrameModule().validateModule();
			getSCMultiFrameImageModule().validateModule();
			getSOPCommonModule().validateModule();

			/*
			 * Validation for attribute PatientOrientation(0020,0020) of GeneralImageModule is implemented at IOD level.
			 * condition :- Required if image does not require Image Orientation (Patient)(0020,0037) and Image Position (Patient)
			 * 				(0020,0032). See C.7.6.1.1.1 for further explanation.
			 * Right now we are taking it as if IOD contains any module which has (0020,0037) and (0020,0032)
			 * and if that module and attribute are compulsory then (0020,0020) is not mandatory.
			 * If no module is there in IOD then (0020,0020) is mandatory.
			 * and if attribute or module is optional or conditional then 0020,0020 is also conditional.
			 * THIS IOD DOES NOT CONTAIN ANY MODULE containing THESE ATTRIBUTES.
			 */
			if( !getGeneralImageModule().isPresent(0x0020,0x0020))
			{
				ConditionFailedException cce = new ConditionFailedException("0020,0020");
				if(DicomConfig.createInstance().isLoggingOn())
					DicomLogger.getLogger().log(cce.getMessage());
				throw cce;

			}

			/*
			 * This condition checks for Conditional Modules validation of MultiFrame Grayscale Byte SC Image IOD.
			 */
			ISingleCollection<ITag> objISingleCollection = getMultiFrameModule().getFrameIncrementPointer();
			ITag objITagFrameTime = new Tag(0x0018,0x1063);
			ITag objITagFrameTimeVector = new Tag(0x0018,0x1065);
			if(objISingleCollection != null)
			{
				if(objISingleCollection.contains(objITagFrameTime) || objISingleCollection.contains(objITagFrameTimeVector) && (!(isModulePresent(CineModule.objSingleCollection,objIDataSet))))
					throw new InvalidIODException(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD);
			}
			else 
			{
				if(isModulePresent(CineModule.objSingleCollection,objIDataSet))
					getCineModule().validateModule();
			}

			String strNumberofFrames = getMultiFrameModule().getNumberOfFrames();
			if((Integer.parseInt(strNumberofFrames) > 1) && (!isModulePresent(SCMultiFrameVectorModule.objSingleCollection,objIDataSet)))
				throw new InvalidIODException(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD);
			/*
			 * VOILUT Module is depending on itself's attributes.So in this case condition of invalidation is not properly clear.  
			 */
			if(!((isPresent(0x0028,0x3010)) || isPresent(0x0028,0x1050)) && (!isModulePresent(VOILUTModule.objSingleCollection,objIDataSet)))
				throw new InvalidIODException(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD);
			if(isModulePresent(VOILUTModule.objSingleCollection,objIDataSet))
				getVOILUTModule().validateModule();
			/*
			 * This condition checks for MultiFrame Grayscale Byte SC Image IOD's User Optional modules validation
			 * For conditional modules, first the presence of the modules should be checked. Because
			 * absence of optional modules is not a problem whereas presence but invalid status of the
			 * optional module is a problem.
			 */
			if(isModulePresent(FramePointersModule.objSingleCollection, objIDataSet))
				getFramePointersModule().validateModule();
			if(isModulePresent(SCImageModule.objSingleCollection, objIDataSet))
				getSCImageModule().validateModule();
			if(isModulePresent(GeneralEquipmentModule.objSingleCollection, objIDataSet))
				getGeneralEquipmentModule().validateModule();

			if(isModulePresent(FrameOfReferenceModule.objSingleCollection, objIDataSet))
				getFrameOfReferenceModule().validateModule();
			if(isModulePresent(MultiFrameFunctionalGroupsModule.objSingleCollection, objIDataSet))
				getMultiFrameFunctionalGroupsModule().validateModule();
			if(isModulePresent(MultiFrameDimensionModule.objSingleCollection, objIDataSet))
				getMultiFrameDimensionModule().validateModule();
			if(isModulePresent(SynchronizationModule.objSingleCollection, objIDataSet))
				getSynchronizationModule().validateModule();
			if(isModulePresent(DeviceModule.objSingleCollection, objIDataSet))
				getDeviceModule().validateModule();
			if(isModulePresent(SpecimenModule.objSingleCollection, objIDataSet))
				getSpecimenModule().validateModule();
			if(isModulePresent(CommonInstanceReferenceModule.objSingleCollection, objIDataSet))
				getCommonInstanceReferenceModule().validateModule();
			if(isModulePresent(FrameExtractionModule.objSingleCollection, objIDataSet))
				getFrameExtractionModule().validateModule();
			

			/*
			 * These conditions check for MultiFrame Grayscale Byte SC Image IOD Content Constraints.
			 * If any of these conditions fail it should throw invalid IOD Exception.
			 * Please refer page np.d.f Chapter 3 page no 105 A.8.3.4
			 */
			ImagePixelModule objImagePixelModule = getImagePixelModule();

			if((objImagePixelModule.getImagePixelMacro().getSamplesPerPixel() != EnumSamplesPerPixel.ONE.getValue()) || 
					(objImagePixelModule.getImagePixelMacro().getPhotometricInterpretation() != EnumPhotometricInterpretation.MONOCHROME2.getValue())||
					(objImagePixelModule.getImagePixelMacro().getBitsAllocated() != EnumBitsAllocated.EIGHT.getValue()) ||
					(objImagePixelModule.getImagePixelMacro().getBitsStored() != EnumBitsStored.EIGHT.getValue())||
					(objImagePixelModule.getImagePixelMacro().getHighBit() != EnumHighBit.SEVEN.getValue())||
					(objImagePixelModule.getImagePixelMacro().getPixelRepresentation() != EnumPixelRepresentation.ZERO.getValue())||
					(objImagePixelModule.isPresent(0x0028,0x0006)))
				throw new InvalidIODException(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD);
			
			// checking for presence of Image data
			if(!isPresent(0x7FE0,0x0010))
			{
				InvalidIODException iie= new InvalidIODException(ResourceBundleWrapper.getValue("exceptions", "ImageData", new Locale(DicomConfig.createInstance().getLocale())));
				if(DicomConfig.createInstance().isLoggingOn())
					DicomLogger.getLogger().log(iie.getMessage());
				throw iie;

			}
		}
		catch(InvalidModuleException ime)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(ime.getMessage());
			
				throw new InvalidIODException(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD, ime);
		}
		return true;
	}

	/**
	 *  Dumps the Name of IOD,Module and corresponding Attributs of Module.
	 *  @param objIDicomStream - the Stream on which the Data is to be written.
	 *  @throws IOException - Exception is thrown indicating runtime failure of writing operation.
	 */
	public void dumpDICOMInfo(IDicomStream objIDicomStream) throws IOException
	{
		objIDicomStream.writeString(MULTIFRAME_GRAYSCALE_BYTE_SC_IMAGE_IOD + "\n");
		super.dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getCineModule().getClass().getSimpleName() + "\n");
		getCineModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getFramePointersModule().getClass().getSimpleName() + "\n");
		getFramePointersModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getGeneralImageModule().getClass().getSimpleName() + "\n");
		getGeneralImageModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getMultiFrameModule().getClass().getSimpleName() + "\n");
		getMultiFrameModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getFrameOfReferenceModule().getClass().getSimpleName() + "\n");
		getFrameOfReferenceModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getMultiFrameFunctionalGroupsModule().getClass().getSimpleName() + "\n");
		getMultiFrameFunctionalGroupsModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getMultiFrameDimensionModule().getClass().getSimpleName() + "\n");
		getMultiFrameDimensionModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getSynchronizationModule().getClass().getSimpleName() + "\n");
		getSynchronizationModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getDeviceModule().getClass().getSimpleName() + "\n");
		getDeviceModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getSpecimenModule().getClass().getSimpleName() + "\n");
		getSpecimenModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSCImageModule().getClass().getSimpleName() + "\n");
		getSCImageModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSCMultiFrameImageModule().getClass().getSimpleName() + "\n");
		getSCMultiFrameImageModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSCMultiFrameVectorModule().getClass().getSimpleName() + "\n");
		getSCMultiFrameVectorModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSCEquipmentModule().getClass().getSimpleName() + "\n");
		getSCEquipmentModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getSOPCommonModule().getClass().getSimpleName() + "\n");
		getSOPCommonModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getCommonInstanceReferenceModule().getClass().getSimpleName() + "\n");
		getCommonInstanceReferenceModule().dumpDICOMInfo(objIDicomStream);
		
		objIDicomStream.writeString("\t" + getFrameExtractionModule().getClass().getSimpleName() + "\n");
		getFrameExtractionModule().dumpDICOMInfo(objIDicomStream);

		objIDicomStream.writeString("\t" + getVOILUTModule().getClass().getSimpleName() + "\n");
		getVOILUTModule().dumpDICOMInfo(objIDicomStream);
	}

	/**
	 * Checks whether the Module is present in the IOD or not.
	 * @param strModuleName String value of module name 
	 * @return boolean - true if the module is present in the IOD, else false is returned.
	 */
	public boolean isModulePresent(String strModuleName)
	{
		if(!super.isModulePresent(strModuleName))
		{
			if(strModuleName == null || strModuleName.equals(""))
				return false;
			if(strModuleName.equalsIgnoreCase(EnumModuleNames.CINE_MODULE.getValue()) && isModulePresent(CineModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.FRAME_POINTERS_MODULE.getValue()) && isModulePresent(FramePointersModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.GENERAL_IMAGE_MODULE.getValue()) && isModulePresent(GeneralImageModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_FRAME_MODULE.getValue()) && isModulePresent(MultiFrameModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.FRAME_OF_REFERENCE_MODULE.getValue()) && isModulePresent(FrameOfReferenceModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_FRAME_FUNCTIONAL_GROUPS_MODULE.getValue()) && isModulePresent(MultiFrameFunctionalGroupsModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.MULTI_FRAME_DIMENSION_MODULE.getValue()) && isModulePresent(MultiFrameDimensionModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SYNCHRONIZATION_MODULE.getValue()) && isModulePresent(SynchronizationModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.DEVICE_MODULE.getValue()) && isModulePresent(DeviceModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SPECIMEN_MODULE.getValue()) && isModulePresent(SpecimenModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SC_IMAGE_MODULE.getValue()) && isModulePresent(SCImageModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SC_MULTI_FRAME_IMAGE_MODULE.getValue()) && isModulePresent(SCMultiFrameImageModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SC_MULTI_FRAME_VECTOR_MODULE.getValue()) && isModulePresent(SCMultiFrameVectorModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SC_EQUIPMENT_MODULE.getValue()) && isModulePresent(SCEquipmentModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.SOP_COMMON_MODULE.getValue()) && isModulePresent(SOPCommonModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.COMMON_INSTANCE_REFERENCE_MODULE.getValue()) && isModulePresent(CommonInstanceReferenceModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.FRAME_EXTRACTION_MODULE.getValue()) && isModulePresent(FrameExtractionModule.objSingleCollection))
				return true;
			else if(strModuleName.equalsIgnoreCase(EnumModuleNames.VOI_LUT_MODULE.getValue()) && isModulePresent(VOILUTModule.objSingleCollection))
				return true;
			else
			{
				if(DicomConfig.createInstance().isLoggingOn())
				{
					DicomLogger objDicomLogger = DicomLogger.getLogger();
					objDicomLogger.log(this.getClass().getName() + " : " +ResourceBundleWrapper.getValue("status","ModuleNotPresent",new Locale(DicomConfig.createInstance().getLocale())) + strModuleName);
				}
				return false;
			}
		}
		return true;
	}
}
