cdac.medinfo.sdk.dcm30_04.baselibs

Class PlanningLandmarkLineMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.PlanningLandmarkLineMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class PlanningLandmarkLineMacro
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
PlanningLandmarkLineMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
PlanningLandmarkLineMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
PlanningLandmarkLineMacro(IItem objItem) This constructor constructs a Macro with the specified Item
PlanningLandmarkLineMacro(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[]	getThreeDLineCoordinates() Retrieves the 3D Point Coordinates.
TwoDLineCoordinatesSequence	getTwoDLineCoordinatesSequence() Retrieves pre-initialized object of 2D Line 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	setThreeDLineCoordinates(double[] dblArrThreeDLineCoordinates) Sets the 3D Line Coordinates.
boolean	validate() Validates all the attributes in PlanningLandmarkLineMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in PlanningLandmarkLineMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in PlanningLandmarkLineMacro 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

PlanningLandmarkLineMacro

public PlanningLandmarkLineMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

PlanningLandmarkLineMacro

public PlanningLandmarkLineMacro(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

PlanningLandmarkLineMacro

public PlanningLandmarkLineMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

PlanningLandmarkLineMacro

public PlanningLandmarkLineMacro(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 PlanningLandmarkLineMacro

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 PlanningLandmarkLineMacro 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 PlanningLandmarkLineMacro 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.

getTwoDLineCoordinatesSequence

public TwoDLineCoordinatesSequence getTwoDLineCoordinatesSequence()

Retrieves pre-initialized object of 2D Line 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.

Returns:

TwoDLineCoordinatesSequence - instance of TwoDLineCoordinatesSequence.

setThreeDLineCoordinates

public void setThreeDLineCoordinates(double[] dblArrThreeDLineCoordinates)

Sets the 3D Line Coordinates. 3D Coordinates of the line.

Parameters:

dblArrThreeDLineCoordinates - Double value of 3D Line Coordinates

getThreeDLineCoordinates

public double[] getThreeDLineCoordinates()

Retrieves the 3D Point Coordinates. 3D Coordinates of the line.

Returns:

double - double value of 3D Line Coordinates