/*******************************************************************************
 *  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.BasicPixelSpacingCalibrationMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.DicomV3Factory;
import cdac.medinfo.sdk.dcm30_04.baselibs.DocumentClassCodeSequence;
import cdac.medinfo.sdk.dcm30_04.baselibs.OptionalViewandSliceProgressionDirectionMacro;
import cdac.medinfo.sdk.dcm30_04.baselibs.Tag;
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.utils.DicomConstants;
import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;
import cdac.medinfo.sdk.dcm30_04.utils.SingleCollection;

// TODO: Auto-generated Javadoc
/**
 \* This module contains IOD Attributes that describe Secondary Capture Images.
 */

public class SCImageModule extends Module  
{

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

	 

	/**
	 * Instantiates a new sC image module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
 
 BasicPixelSpacingCalibrationMacro objBasicPixelSpacingCalibrationMacro=null;
	OptionalViewandSliceProgressionDirectionMacro objOptionalViewandSliceProgressionDirectionMacro=null;

	public SCImageModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}
	
	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1012));
		objSingleCollection.add(new Tag(0x0018,0x1014));
	}

	/**
	 * 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
	{
		/*All attributes in this module are optional*/
		return true;
	}
	
	/**
	 * Sets the date the Secondary Capture Image was captured.
	 * 
	 * @param strDateOfSecondaryCapture - String value of Date of Secondary Capture.
	 */
	public void setDateOfSecondaryCapture(String strDateOfSecondaryCapture)
	{
		/* Accept Date of Secondary Capture in String format of type DA.
		 * 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(0x0018, 0x1012, DicomConstants.DCM_DT_DA, strDateOfSecondaryCapture);
	}

	/**
	 * Retrieves the date the Secondary Capture Image was captured.
	 * 
	 * @return String - String value of Date of Secondary Capture.
	 */
	public String getDateOfSecondaryCapture()
	{
		Object objectValue = getValue(0x0018, 0x1012);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}	

	/**
	 * Sets the time the Secondary Capture Image was captured.
	 * 
	 * @param strTimeOfSecondaryCapture the str time of secondary capture
	 */
	public void setTimeOfSecondaryCapture(String strTimeOfSecondaryCapture)
	{
		/* Accept Time of Secondary Capture in String format of type TM.
		 * 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(0x0018, 0x1014, DicomConstants.DCM_DT_TM, strTimeOfSecondaryCapture);
	}

	/**
	 * Retrieves the time the Secondary Capture Image was captured.
	 * 
	 * @return String - String value of Time of Secondary Capture.
	 */
	public String getTimeOfSecondaryCapture()
	{
		Object objectValue = getValue(0x0018, 0x1014);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}	
	
	/**
	 * Sets Nominal Scanned Pixel Spacing
	 * @param strNominalScannedPixelSpacing String value of Nominal Scanned Pixel Spacing
	 */
	public void setNominalScannedPixelSpacing(String[] strNominalScannedPixelSpacing)
	{
		/*Accept the NominalScannedPixelSpacing in String format of type DS.
		 * 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(0x0018, 0x2010, DicomConstants.DCM_DT_DS,strNominalScannedPixelSpacing);
	}
	/**
	 * Retrieves Nominal Scanned Pixel Spacing
	 * @return String - value of Nominal Scanned Pixel Spacing
	 */
	public String[] getNominalScannedPixelSpacing()
	{
		Object objValue = getValue(0x0018,0x2010);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Sequence of Repeating Items that describe the energy window groups used.
	 * The number of items shall be equal to Number of Energy Windows (0054,0011).
	 * The first item corresponds to frames with value of 1 in the Energy Window Vector
	 * (0054,0010), the second item with value 2, etc.
	 * 
	 * @return the Document Class Code Sequence
	 */
	public DocumentClassCodeSequence getDocumentClassCodeSequence()
	{
		DocumentClassCodeSequence objDocumentClassCodeSequence= (DocumentClassCodeSequence)getDicomValue(0x0054, 0x0012);
		if(objDocumentClassCodeSequence == 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();
			objDocumentClassCodeSequence = (DocumentClassCodeSequence)objDicomV3Factory.createSequence(0x0040, 0xE008, objITransferSyntax, objIDictionaryReader);
			
			// This will add Data Element of SQ to the DataSet.
			addDataElement(0x0040, 0xE008, DicomConstants.DCM_DT_SQ, objDocumentClassCodeSequence.getValue());
		}
		return objDocumentClassCodeSequence;
	}
	
	/**
	 * Returns instance of Basic Pixel Spacing Calibration Macro.
	 * 
	 * @return Instance of Basic Pixel Spacing Calibration Macro
	 */
	public BasicPixelSpacingCalibrationMacro getBasicPixelSpacingCalibrationMacro()
	{
		if(objBasicPixelSpacingCalibrationMacro == null)
		{
			objBasicPixelSpacingCalibrationMacro = new BasicPixelSpacingCalibrationMacro(objIDataSet,objIDictionaryReader);
		}
		return objBasicPixelSpacingCalibrationMacro;
	}
	
	/**
	 * This method returns the Basic Pixel Spacing Calibration Macro
	 * 
	 * @return OptionalViewandSliceProgressionDirectionMacro - object representing Basic Pixel Spacing Calibration Macro
	 */
	public OptionalViewandSliceProgressionDirectionMacro getOptionalViewandSliceProgressionDirectionMacro()
	{
		if(objOptionalViewandSliceProgressionDirectionMacro == null)
		{
			objOptionalViewandSliceProgressionDirectionMacro = new OptionalViewandSliceProgressionDirectionMacro(objIDataSet);
		}
		return objOptionalViewandSliceProgressionDirectionMacro;
	}
	
	/**
	 * 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;
	}
}
