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

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 is used for Bitmap Display Shutter Module.
*/
public class BitmapDisplayShutterModule extends Module  
{


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

	/**
	 * Creates Bitmap Display Shutter Modulee with default initialization.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public BitmapDisplayShutterModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}



	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1600));
		objSingleCollection.add(new Tag(0x0018,0x1622));
		objSingleCollection.add(new Tag(0x0018,0x1623));
		objSingleCollection.add(new Tag(0x0018,0x1624));
	}

	/**
	 * 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,0x1600))
				throw new MandatoryMissingException("0018,1600");
			if(!isPresent(0x0018,0x1622))
				throw new MandatoryMissingException("0018,1622");
			if(!isPresent(0x0018,0x1623))
				throw new MandatoryMissingException("0018,1623");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets Shape of the shutter defined for display.
	 * 
	 * @param enumShutterShape the enum shutter shape
	 */
	public void setShutterShape(EnumShutterShape[] enumShutterShape)
	{
		/* Accept Shutter Shape in String Array 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
		 */
		String[] arrstrShutterShape = new String[enumShutterShape.length];
		for(int i=0;i < enumShutterShape.length ; i++)
		{
			arrstrShutterShape[i] = enumShutterShape[i].getValue();
		}
		addDataElement(0x0018,0x1600, DicomConstants.DCM_DT_CS, arrstrShutterShape);
	}

	/**
	 * Retrieves Shape of the shutter defined for display.
	 * 
	 * @return the shutter shape
	 */
	public String[] getShutterShape()
	{
		Object objValue = getValue(0x0018,0x1600);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}

	/**
	 * Sets the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.
	 * 
	 * @param shShutterOverlayGroup short value of Shutter Overlay Group.
	 */
	public void setShutterOverlayGroup(short shShutterOverlayGroup)
	{
		/* Accept Shutter Overlay Group in short format of type US.
		 * 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,0x1623, DicomConstants.DCM_DT_US, shShutterOverlayGroup);
	}

	/**
	 * Retrieves the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.
	 * 
	 * @return short - short value of Shutter Overlay Group.
	 */
	public short getShutterOverlayGroup()
	{
		Object objValue = getValue(0x0018,0x1623);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}

	/**
	 * Sets the value used to replace those parts of the image occluded by the shutter, in PValues.
	 * 
	 * @param shShutterPresentationValue short value of Shutter Presentation Value.
	 */
	public void setShutterPresentationValue(short shShutterPresentationValue)
	{
		/* Accept Shutter Presentation Value in short format of type US.
		 * 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,0x1622, DicomConstants.DCM_DT_US, shShutterPresentationValue);
	}

	/**
	 * Retrieves the value used to replace those parts of the image occluded by the shutter, in PValues.
	 * 
	 * @return short - short value of Shutter Presentation Value.
	 */
	public short getShutterPresentationValue()
	{
		Object objValue = getValue(0x0018,0x1622);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}
	
	/**
	 * Sets the Shutter Presentation Color CIE Lab Value.
	 * A color triplet value used to replace those parts of the image occluded by the shutter, when rendered on a color display.
	 * @param sShutterPresentationColorCIELabValue short value of Shutter Presentation Color CIE Lab Value.
	 */
	public void setShutterPresentationColorCIELabValue(short sShutterPresentationColorCIELabValue)
	{
		/* Accept Shutter Presentation Color CIE Lab Value in short format of type US.
		 * 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, 0x1624, DicomConstants.DCM_DT_US, sShutterPresentationColorCIELabValue);
	}

	/**
	 * Retrieves the Shutter Presentation Color CIE Lab Value.
	 * 
	 * @return short - short value of Shutter Presentation Color CIE Lab Value.
	 */
	public short getShutterPresentationColorCIELabValue()
	{
		Object objValue = getValue(0x0018,0x1624);
		if(objValue != null)
			return Short.parseShort(objValue.toString());
		return DicomConstants.DCM_NO_VALUE;
	}


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