cdac.medinfo.sdk.dcm30_04.baselibs

Class PlanningLandmarkPlaneMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.PlanningLandmarkPlaneMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class PlanningLandmarkPlaneMacro
extends Macro

This class contains a Macro that contains definition of landmarks that can be used during planning to align an implant template with patient geometry.

Author:

saloni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PlanningLandmarkPlaneMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
PlanningLandmarkPlaneMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
PlanningLandmarkPlaneMacro(IItem objItem) This constructor constructs a Macro with the specified Item
PlanningLandmarkPlaneMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getThreeDPlaneNormal() Retrieves the 3D Plane Normal.
double[]	getThreeDPlaneOrigin() Retrieves the 3D Plane Origin.
TwoDPlaneCoordinatesSequence	getTwoDPlaneCoordinatesSequence() Retrieves pre-initialized object of 2D Plane Coordinates Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
void	setThreeDPlaneNormal(double[] dblArrThreeDPlaneNormal) Sets the 3D Plane Normal.
void	setThreeDPlaneOrigin(double[] dblArrThreeDPlaneOrigin) Sets the 3D Plane Origin.
boolean	validate() Validates all the attributes in PlanningLandmarkPlaneMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanningLandmarkPlaneMacro

public PlanningLandmarkPlaneMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

PlanningLandmarkPlaneMacro

public PlanningLandmarkPlaneMacro(IDataSet objDataSet,
                          IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

PlanningLandmarkPlaneMacro

public PlanningLandmarkPlaneMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

PlanningLandmarkPlaneMacro

public PlanningLandmarkPlaneMacro(IItem objItem,
                          IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in PlanningLandmarkPlaneMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in PlanningLandmarkPlaneMacro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

getTwoDPlaneCoordinatesSequence

public TwoDPlaneCoordinatesSequence getTwoDPlaneCoordinatesSequence()

Retrieves pre-initialized object of 2D Plane Coordinates Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence. 2D coordinates of the point in the HPGL documents.

Returns:

TwoDPlaneCoordinatesSequence - instance of TwoDPlaneCoordinatesSequence.

setThreeDPlaneOrigin

public void setThreeDPlaneOrigin(double[] dblArrThreeDPlaneOrigin)

Sets the 3D Plane Origin. 3D Coordinates of the plane origin.

Parameters:

dblArrThreeDPlaneOrigin - Double value of 3D Plane Origin

getThreeDPlaneOrigin

public double[] getThreeDPlaneOrigin()

Retrieves the 3D Plane Origin. 3D Coordinates of the plane origin.

Returns:

double - double value of 3D Plane Origin

setThreeDPlaneNormal

public void setThreeDPlaneNormal(double[] dblArrThreeDPlaneNormal)

Sets the 3D Plane Normal. 3D Coordinates of the plane normal.

Parameters:

dblArrThreeDPlaneNormal - Double value of 3D Plane Normal

getThreeDPlaneNormal

public double[] getThreeDPlaneNormal()

Retrieves the 3D Plane Normal. 3D Coordinates of the plane normal.

Returns:

double - double value of 3D Plane Normal