/*******************************************************************************
 *  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.Tag;
import cdac.medinfo.sdk.dcm30_04.baselibs.XRayGridDescriptionMacro;
import cdac.medinfo.sdk.dcm30_04.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumGrid;
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 describes the attributes related to the use of a grid to reduce scatter of X-rays during
 * the acquisition of an X-Ray image.
 */
public class XRayGridModule extends Module  
{

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

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		//Data Element Hash Map
		objSingleCollection.add(new Tag(0x0018,0x1166));
		objSingleCollection.add(new Tag(0x0018,0x7040));
		objSingleCollection.add(new Tag(0x0018,0x7041));
		objSingleCollection.add(new Tag(0x0018,0x7042));
		objSingleCollection.add(new Tag(0x0018,0x7044));
		objSingleCollection.add(new Tag(0x0018,0x7046));
		objSingleCollection.add(new Tag(0x0018,0x7048));
		objSingleCollection.add(new Tag(0x0018,0x704C));
	}

	/**
	 * Instantiates a new x ray grid module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public XRayGridModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	/**
	 * 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 value that identifies the grid. May be multi-valued.
	 * Defined Terms are: FIXED,FOCUSED,RECIPROCATING,PARALLEL,CROSSED,NONE.
	 * 
	 * @param enumGrid array of values that identify the grid.
	 */
	public void setGrid(EnumGrid[] enumGrid)
	{
		/* Accept Grid in String Array format of type CS.
		 * 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
		 */
		String[] arrStrGrid = new String[enumGrid.length];
		for(int i=0;i < enumGrid.length ; i++)
		{
			arrStrGrid[i] = enumGrid[i].getValue();
		}
		addDataElement(0x0018,0x1166, DicomConstants.DCM_DT_CS, arrStrGrid);
	}

	/**
	 * Return value that identifies the grid.
	 * 
	 * @return String[] - String array that identify the grid.
	 */
	public String[] getGrid()
	{
		Object objValue = getValue(0x0018,0x1166);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}
	
	/**
	 * Returns instance XRayGridDescriptionMacro
	 * 
	 * @return Instance of XRayGridDescriptionMacro
	 */
	public XRayGridDescriptionMacro getXRayGridDescriptionMacro()
	{
		if(objXRayGridDescriptionMacro == null)
		{
			objXRayGridDescriptionMacro = new XRayGridDescriptionMacro(objIDataSet,objIDictionaryReader);
		}
		return objXRayGridDescriptionMacro;
	}

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