/*******************************************************************************
 *  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.commoninterface.IDataSet;
import cdac.medinfo.sdk.dcm30_04.commoninterface.ITag;
import cdac.medinfo.sdk.dcm30_04.enums.EnumIntensifierActiveShape;

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 class specifies the attributes of the X-Ray Image Intensifier Module.
 * @author saloni
 *
 */
public class XRayImageIntensifierModule extends Module  
{
	
	

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

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


	/**
	 * Instantiates a new waveform identification module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public XRayImageIntensifierModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1162));
		objSingleCollection.add(new Tag(0x0018,0x9427));
		objSingleCollection.add(new Tag(0x0018,0x9428));
	}


	/**
	 * 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(0x0018,0x1162))
				throw new MandatoryMissingException("0018,1162");
			if(!isPresent(0x0018,0x9427))
				throw new MandatoryMissingException("0018,9427");
			if(!isPresent(0x0018,0x9428))
				throw new MandatoryMissingException("0018,9428");
		}
		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 diameter of X-Ray intensifier in mm.
	 * 
	 * @param strIntensifierSize String value of Intensifier Size
	 */
	public void setIntensifierSize(String strIntensifierSize)
	{
		/*Accept Intensifier Size 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 Hash Map
		 */
		addDataElement(0x0018,0x1162, DicomConstants.DCM_DT_DS, strIntensifierSize);
	}

	/**
	 * Returns diameter of X-Ray intensifier in mm.
	 * 
	 * @return String - String value of Intensifier Size
	 */
	public String getIntensifierSize()
	{
		Object objectValue = getValue(0x0018, 0x1162);
		if(objectValue!=null)
			return objectValue.toString();
		return null;
	}
	/**
	 * Sets Intensifier Active Shape.
	 * Enumerated Values:
	 * 1) RECTANGLE
	 * 2) ROUND.
	 * 3) HEXAGONAL.
	 * 
	 * @param enumIntensifierActiveShape the enum approval status
	 */
	public void setIntensifierActiveShape(EnumIntensifierActiveShape  enumIntensifierActiveShape)
	{
		/* Accept Intensifier Active Shape 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(0x0018,0x9427, DicomConstants.DCM_DT_CS, enumIntensifierActiveShape.getValue());
	}

	/**
	 * Retrieves Intensifier Active Shape.
	 * 
	 * @return String - String value of Intensifier Active Shape.
	 */ 
	public String getIntensifierActiveShape()
	{
		Object objValue = getValue(0x0018,0x9427);
		if(objValue != null)
			return objValue.toString();
		return null;
	}
	
	/**
	 * Sets Intensifier Active Dimension(s)
	 * @param fArrIntensifierActiveDimensions Float value of the Intensifier Active Dimension(s)
	 */
	public void setCalciumScoringMassFactorPatient( float[] fArrIntensifierActiveDimensions)
	{
		/*
		 * Accept the IntensifierActiveDimensions in String format of type FL.
		 * 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,0x9428, DicomConstants.DCM_DT_FL,fArrIntensifierActiveDimensions);
	}
	/**
	 * Retrieves Intensifier Active Dimension(s)
	 * @return float - Float value of the Intensifier Active Dimension(s)
	 */
	public float[] getIntensifierActiveDimensions()
	{
		Object objValue = getValue(0x0018,0x9428);
		if(objValue != null)
			return (float[])objValue;
		return null;
	}
	
	
}
