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

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 describes equipment used to create Hardcopy Grayscale and Color Image IODs.
 * 
 * 
 */
public class HardcopyEquipmentModule extends Module 
{
	/**
	 * The obj single collection.
	 */
	public static ISingleCollection<ITag> objSingleCollection = null;

	/**
	 * Instantiates a new hardcopy equipment module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public HardcopyEquipmentModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0008,0x0060));
		objSingleCollection.add(new Tag(0x0018,0x1011));
		objSingleCollection.add(new Tag(0x0018,0x1017));
		objSingleCollection.add(new Tag(0x0018,0x101A));
		objSingleCollection.add(new Tag(0x0018,0x101B));
	}

	/**
	 * 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 true, if validate module
	 * 
	 * @throws InvalidModuleException - If validation of Module fails
	 */

	public  boolean validateModule() throws InvalidModuleException
	{

		try
		{			/*
		 * Validation Rules for Mandatory Elements
		 */
			if(!isPresent(0x0008,0x0060))
				throw new MandatoryMissingException("Missing Mandatory Element 0008,0060");
		}
		catch(MandatoryMissingException mme)
		{
			if(DicomConfig.createInstance().isLoggingOn())
				DicomLogger.getLogger().log(mme.getMessage());

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

		}
		return true;
	}

	/**
	 * Sets type of equipment that originally acquired the data used to create the images in this Series.
	 * 
	 * @param enumModality - enum value of Modality
	 */	
	public void setModality(EnumModality enumModality)
	{
		/*Accept the Modality value 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 Hash Map
		 */
		addDataElement(0x0008, 0x0060, DicomConstants.DCM_DT_CS, enumModality.getValue());
	}

	/**
	 * Return type of equipment that originally acquired the data used to create the images in this Series.
	 * 
	 * @return String - String value of Modality
	 */
	public String getModality()
	{
		Object objValue = objIDataSet.getValue(0x0008, 0x0060);
		if(objValue != null)
			return	objValue.toString();
		return null;
	}

	/**
	 * Sets user defined identification of the device that created this Hardcopy Image.
	 * 
	 * @param strHardcopyCreationDeviceID the str hardcopy creation device id
	 */
	public void setHardcopyCreationDeviceID(String strHardcopyCreationDeviceID)
	{
		/* Accept the Hardcopy Creation Device ID in String format of type LO.
		 * 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(0x0008, 0x1011, DicomConstants.DCM_DT_LO, strHardcopyCreationDeviceID);
	}

	/**
	 * Return user defined identification of the device that created this Hardcopy Image.
	 * 
	 * @return String - String value of Hardcopy Creation Device ID
	 */
	public String getHardcopyCreationDeviceID()
	{
		Object objValue = objIDataSet.getValue(0x0018, 0x1011);
		if(objValue != null)
			return	objValue.toString();
		return null;
	}

	/**
	 * Sets Manufacturer of the device that created this Hardcopy Image.
	 * 
	 * @param strHardcopyDeviceManufacturer the str hardcopy device manufacturer
	 */
	public void setHardcopyDeviceManufacturer(String strHardcopyDeviceManufacturer)
	{
		/* Accept the Hardcopy Device Manufacturer in String format of type LO.
		 * 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, 0x1017, DicomConstants.DCM_DT_LO, strHardcopyDeviceManufacturer);
	}

	/**
	 * Return Manufacturer of the device that created this Hardcopy Image.
	 * 
	 * @return String - String value of Hardcopy Device Manufacturer
	 */
	public String getHardcopyDeviceManufacturer()
	{
		Object objValue = objIDataSet.getValue(0x0018, 0x1017);
		if(objValue != null)
			return	objValue.toString();
		return null;
	}

	/**
	 * Sets manufacturer's designation of the software of the device that created this Hardcopy Image.
	 * 
	 * @param arrStrHardcopyDeviceSoftwareVersion the arr str hardcopy device software version
	 */
	public void setHardcopyDeviceSoftwareVersion(String[] arrStrHardcopyDeviceSoftwareVersion)
	{
		/* Accept the Hardcopy Device Software Version in String format of type LO.
		 * 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, 0x101A, DicomConstants.DCM_DT_LO,arrStrHardcopyDeviceSoftwareVersion);
	}

	/**
	 * Return manufacturer's designation of the software of the device that created this Hardcopy Image.
	 * 
	 * @return String - String value of Hardcopy Device Manufacturer
	 */
	public String[] getHardcopyDeviceSoftwareVersion()
	{
		Object objValue = objIDataSet.getValue(0x0018, 0x101A);
		if(objValue != null)
			return (String[])objValue;
		return null;
	}

	/**
	 * Sets Manufacturer's model number of the device that created this Hardcopy Image.
	 * 
	 * @param strHardcopyDeviceManfuacturersModelName the str hardcopy device manfuacturers model name
	 */
	public void setHardcopyDeviceManfuacturersModelName(String strHardcopyDeviceManfuacturersModelName)
	{
		/* Accept the Hardcopy Device Manfuacturer's Model Name in String format of type LO.
		 * 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, 0x101B, DicomConstants.DCM_DT_LO, strHardcopyDeviceManfuacturersModelName);
	}

	/**
	 * Return Manufacturer of the device that created this Hardcopy Image.
	 * 
	 * @return String - String value of Hardcopy Device Manfuacturer's Model Name
	 */
	public String getHardcopyDeviceManfuacturersModelName()
	{
		Object objValue = objIDataSet.getValue(0x0018, 0x101B);
		if(objValue != null)
			return	objValue.toString();
		return null;
	}

	/**
	 * This method returns the custom collection containing the list of DataElements belonging to the CT
	 * Image Module specified by DICOM Standard.
	 * 
	 * @return collection - custom collection containing the list of DataElements belonging to the CT Image Module
	 */
	public ISingleCollection<ITag> getVectorOfKeys()
	{
		return objSingleCollection;
	}
}
