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

/**
 \* This module contains IOD attributes that describe a c-arm positioner typically used in acquiring
 * X-Ray RF Images.
 */
public class XRFPositionerModule extends Module  
{

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

	/**
	 * Instantiates a new xRF positioner module.
	 * 
	 * @param objIDataSet the obj i data set
	 */
	public XRFPositionerModule(IDataSet objIDataSet)
	{
		super(objIDataSet);
	}

	static
	{
		objSingleCollection = new SingleCollection<ITag>();
		objSingleCollection.add(new Tag(0x0018,0x1110));
		objSingleCollection.add(new Tag(0x0018,0x1111));
		objSingleCollection.add(new Tag(0x0018,0x1114));
		objSingleCollection.add(new Tag(0x0018,0x1450));
	}

	/**
	 * 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 are optional*/ 
		return true;
	}

	/**
	 * Sets Distance in mm from source to isocenter.
	 * 
	 * @param strDistanceSourceToPatient the str distance source to patient
	 */
	public void setDistanceSourceToPatient(String strDistanceSourceToPatient)
	{
		/*Accept Distance in mm from source to isocenter 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, 0x1111, DicomConstants.DCM_DT_DS, strDistanceSourceToPatient);
	}

	/**
	 * Return Distance in mm from source to isocenter.
	 * 
	 * @return String - String value of Distance Source to Patient
	 */
	public String getDistanceSourceToPatient()
	{
		Object objValue = getValue(0x0018,0x1111);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Distance in mm from source to detector.
	 * 
	 * @param strDistanceSourceToDetector the str distance source to detector
	 */
	public void setDistanceSourceToDetector(String strDistanceSourceToDetector)
	{
		/*Accept the Distance Source to Detector 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,0x1110, DicomConstants.DCM_DT_DS, strDistanceSourceToDetector);
	}

	/**
	 * Return Distance in mm from source to detector.
	 * 
	 * @return String - String value of Distance Source to detector
	 */
	public String getDistanceSourceToDetector()
	{
		Object objValue = getValue(0x0018,0x1110);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).
	 * 
	 * @param strEstimatedRadiographicMagnificationFactor the str estimated radiographic magnification factor
	 */
	public void setEstimatedRadiographicMagnificationFactor(String strEstimatedRadiographicMagnificationFactor)
	{
		/* Accept Estimated Radiographic Magnification Factor 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, 0x1114, DicomConstants.DCM_DT_DS, strEstimatedRadiographicMagnificationFactor);
	}

	/**
	 * Return Ratio of Source Image Receptor Distance (SID) over Source Object Distance (SOD).
	 * 
	 * @return String - String value of Estimated Radiographic Magnification Factor
	 */
	public String getEstimatedRadiographicMagnificationFactor()
	{
		Object objValue = getValue(0x0018,0x1114);
		if(objValue != null)
			return objValue.toString();
		return null;
	}

	/**
	 * Sets angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane.
	 * Positive values indicate that the tilt is toward the head of the table.
	 * 
	 * @param strColumnAngulation - String value of Column Angulation
	 */
	public void setColumnAngulation(String strColumnAngulation)
	{
		/* Accept Column Angulation 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, 0x1450, DicomConstants.DCM_DT_DS, strColumnAngulation);
	}

	/**
	 * Retrievs angle of the X-Ray beam in degree relative to an orthogonal axis to the detector plane.
	 * Positive values indicate that the tilt is toward the head of the table.
	 * 
	 * @return String - String value of Column Angulation
	 */
	public String getColumnAngulation()
	{
		Object objValue = getValue(0x0018,0x1450);
		if(objValue != null)
			return objValue.toString();
		return 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;
	}
}
