cdac.medinfo.sdk.dcm30_04.baselibs

Class XRay3DGeneralPositionerMovementMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.XRay3DGeneralPositionerMovementMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class XRay3DGeneralPositionerMovementMacro
extends Macro

This class specifies the X-Ray 3D General Positioner Movement Macro that specifies the Attributes that describe themovement of a positioner during the acquisition of more than one projection..

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
float	getPrimaryPositionerIncrement() Retrieves the Primary Positioner Increment
float	getPrimaryPositionerIncrementSign() Retrieves the Primary PositionerIncrement Sign
float	getPrimaryPositionerScanArc() Retrieves the Primary Positioner Scan Arc
float	getPrimaryPositionerScanStartAngle() Retrieves the Primary Positioner Scan StartAngle
float	getSecondaryPositionerIncrement() Retrieves the Secondary Positioner Increment
java.lang.String	getSecondaryPositionerIncrementSign() Return Direction of the secondary positioner rotation.
float	getSecondaryPositionerScanArc() Retrieves the Secondary Positioner Scan Arc
float	getSecondaryPositionerScanStartAngle() Retrieves the Secondary Positioner ScanStart Angle
void	setPrimaryPositionerIncrement(float fPrimaryPositionerIncrement) Sets Primary Positioner Increment
void	setPrimaryPositionerIncrementSign(float fPrimaryPositionerIncrementSign) Sets Primary PositionerIncrement Sign
void	setPrimaryPositionerScanArc(float fPrimaryPositionerScanArc) Sets Primary Positioner Scan Arc
void	setPrimaryPositionerScanStartAngle(float fPrimaryPositionerScanStartAngle) Sets Primary Positioner Scan StartAngle
void	setSecondaryPositionerIncrement(float fSecondaryPositionerIncrement) Sets Secondary Positioner Increment
void	setSecondaryPositionerIncrementSign(EnumSecondaryPositionerIncrementSign enumSecondaryPositionerIncrementSign) Sets Direction of the secondary positioner rotation.
void	setSecondaryPositionerScanArc(float fSecondaryPositionerScanArc) Sets Secondary Positioner Scan Arc
void	setSecondaryPositionerScanStartAngle(float fSecondaryPositionerScanStartAngle) Sets Secondary Positioner ScanStart Angle
boolean	validate() Validates all the attributes in XRay3DGeneralPositionerMovementMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in XRay3DGeneralPositionerMovementMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in XRay3DGeneralPositionerMovementMacro 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

XRay3DGeneralPositionerMovementMacro

public XRay3DGeneralPositionerMovementMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

XRay3DGeneralPositionerMovementMacro

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

XRay3DGeneralPositionerMovementMacro

public XRay3DGeneralPositionerMovementMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

XRay3DGeneralPositionerMovementMacro

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

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

setPrimaryPositionerScanArc

public void setPrimaryPositionerScanArc(float fPrimaryPositionerScanArc)

Sets Primary Positioner Scan Arc

Parameters:

fPrimaryPositionerScanArc - Float value of Primary Positioner Scan Arc

getPrimaryPositionerScanArc

public float getPrimaryPositionerScanArc()

Retrieves the Primary Positioner Scan Arc

Returns:

float - Float value of the Primary Positioner Scan Arc

setPrimaryPositionerScanStartAngle

public void setPrimaryPositionerScanStartAngle(float fPrimaryPositionerScanStartAngle)

Sets Primary Positioner Scan StartAngle

Parameters:

fPrimaryPositionerScanStartAngle - Float value of Primary Positioner Scan StartAngle

getPrimaryPositionerScanStartAngle

public float getPrimaryPositionerScanStartAngle()

Retrieves the Primary Positioner Scan StartAngle

Returns:

float - Float value of the Primary Positioner Scan StartAngle

setPrimaryPositionerIncrement

public void setPrimaryPositionerIncrement(float fPrimaryPositionerIncrement)

Sets Primary Positioner Increment

Parameters:

fPrimaryPositionerIncrement - Float value of Primary Positioner Increment

getPrimaryPositionerIncrement

public float getPrimaryPositionerIncrement()

Retrieves the Primary Positioner Increment

Returns:

float - Float value of the Primary Positioner Increment

setPrimaryPositionerIncrementSign

public void setPrimaryPositionerIncrementSign(float fPrimaryPositionerIncrementSign)

Sets Primary PositionerIncrement Sign

Parameters:

fPrimaryPositionerIncrementSign - Float value of Primary PositionerIncrement Sign

getPrimaryPositionerIncrementSign

public float getPrimaryPositionerIncrementSign()

Retrieves the Primary PositionerIncrement Sign

Returns:

float - Float value of the Primary PositionerIncrement Sign

setSecondaryPositionerScanArc

public void setSecondaryPositionerScanArc(float fSecondaryPositionerScanArc)

Sets Secondary Positioner Scan Arc

Parameters:

fSecondaryPositionerScanArc - Float value of Secondary Positioner Scan Arc

getSecondaryPositionerScanArc

public float getSecondaryPositionerScanArc()

Retrieves the Secondary Positioner Scan Arc

Returns:

float - Float value of the Secondary Positioner Scan Arc

setSecondaryPositionerScanStartAngle

public void setSecondaryPositionerScanStartAngle(float fSecondaryPositionerScanStartAngle)

Sets Secondary Positioner ScanStart Angle

Parameters:

fSecondaryPositionerScanStartAngle - Float value of Secondary Positioner ScanStart Angle

getSecondaryPositionerScanStartAngle

public float getSecondaryPositionerScanStartAngle()

Retrieves the Secondary Positioner ScanStart Angle

Returns:

float - Float value of the Secondary Positioner ScanStart Angle

setSecondaryPositionerIncrement

public void setSecondaryPositionerIncrement(float fSecondaryPositionerIncrement)

Sets Secondary Positioner Increment

Parameters:

fSecondaryPositionerScanStartAngle - Float value of Secondary Positioner Increment

getSecondaryPositionerIncrement

public float getSecondaryPositionerIncrement()

Retrieves the Secondary Positioner Increment

Returns:

float - Float value of the Secondary Positioner Increment

setSecondaryPositionerIncrementSign

public void setSecondaryPositionerIncrementSign(EnumSecondaryPositionerIncrementSign enumSecondaryPositionerIncrementSign)

Sets Direction of the secondary positioner rotation.

Parameters:

enumSecondaryPositionerIncrementSign - enum value of Secondary PositionerIncrement Sign

getSecondaryPositionerIncrementSign

public java.lang.String getSecondaryPositionerIncrementSign()

Return Direction of the secondary positioner rotation.

Returns:

String - value of Secondary PositionerIncrement Sign