cdac.medinfo.sdk.dcm30_04.baselibs

Class CompoundGraphicSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.CompoundGraphicSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class CompoundGraphicSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Compound Graphic Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
int	getCompoundGraphicInstanceID() Retrieves Compound Graphic Instance ID.
java.lang.String	getCompoundGraphicType() Return type of Compound Graphic.
java.lang.String	getCompoundGraphicUnits() Return Compound Graphic Units.
float	getDiameterofVisibility() Retrieves the Diameter of Visibility.
FillStyleSequenceMacro	getFillStyleSequenceMacro() This method returns the Fill Style Sequence Macro with proper initialization.
float	getGapLength() Retrieves the Gap Length.
float	getGraphicData() Retrieves the Graphic Data.
short	getGraphicDimensions() Retrieves Graphic Dimensions
java.lang.String	getGraphicFilled() Return type of Graphic Filled.
int	getGraphicGroupID() Retrieves Graphic Group ID.
LineStyleSequenceMacro	getLineStyleSequenceMacro() This method returns the Line Style Sequence Macro with proper initialization.
MajorTicksSequence	getMajorTicksSequence() Retrieves pre-initialized object of Major Ticks 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.
short	getNumberofGraphicPoints() Retrieves Number of Graphic Points
double	getRotationAngle() Retrieves the Rotation Angle.
float	getRotationPoint() Retrieves the Rotation Point.
java.lang.String	getShowTickLabel() Return type of Show Tick Label.
TextStyleSequenceMacro	getTextStyleSequenceMacro() This method returns the Text Style Sequence Macro with proper initialization.
java.lang.String	getTickAlignment() Return type of Tick Alignment.
java.lang.String	getTickLabelAlignment() Return type of Tick Label Alignment.
void	setCompoundGraphicInstanceID(int iCompoundGraphicInstanceID) Sets Compound Graphic Instance ID.
void	setCompoundGraphicType(EnumCompoundGraphicType enumCompoundGraphicType) Sets type of Compound Graphic.
void	setCompoundGraphicUnits(EnumCompoundGraphicUnits enumCompoundGraphicUnits) Sets Compound Graphic Units.
void	setDiameterofVisibility(float fDiameterofVisibility) Sets the Diameter of Visibility.
void	setGapLength(float fGapLength) Sets the Gap Length.
void	setGraphicData(float fGraphicData) Sets the Graphic Data.
void	setGraphicDimensions(short shGraphicDimensions) Sets Graphic Dimensions
void	setGraphicFilled(EnumGraphicFilled enumGraphicFilled) Sets Graphic Filled.
void	setGraphicGroupID(int iGraphicGroupID) Sets Graphic Group ID.
void	setNumberofGraphicPoints(short shNumberofGraphicPoints) Sets Number of Graphic Points
void	setRotationAngle(double dblRotationAngle) Sets the Rotation Angle.
void	setRotationPoint(float fRotationPoint) Sets the Rotation Point.
void	setShowTickLabel(EnumShowTickLabel enumShowTickLabel) Sets Show Tick Label.
void	setTickAlignment(EnumTickAlignment enumTickAlignment) Sets Tick Alignment.
void	setTickLabelAlignment(EnumTickLabelAlignment enumTickLabelAlignment) Sets Tick Label Alignment.
boolean	validateForModule() Validates all the attributes in Compound Graphic Sequence Item that are present in the DataSet

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in Compound Graphic Sequence Item that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

getLineStyleSequenceMacro

public LineStyleSequenceMacro getLineStyleSequenceMacro()

This method returns the Line Style Sequence Macro with proper initialization.

Returns:

- instance of LineStyleSequenceMacro

getTextStyleSequenceMacro

public TextStyleSequenceMacro getTextStyleSequenceMacro()

This method returns the Text Style Sequence Macro with proper initialization.

Returns:

- instance of TextStyleSequenceMacro

getFillStyleSequenceMacro

public FillStyleSequenceMacro getFillStyleSequenceMacro()

This method returns the Fill Style Sequence Macro with proper initialization.

Returns:

- instance of FillStyleSequenceMacro

setCompoundGraphicInstanceID

public void setCompoundGraphicInstanceID(int iCompoundGraphicInstanceID)

Sets Compound Graphic Instance ID. A number that identifies the Compound Graphic described in this Item. The value shall be unique within this SOP instance.

Parameters:

iCompoundGraphicInstanceID - long value of Compound Graphic Instance ID.

getCompoundGraphicInstanceID

public int getCompoundGraphicInstanceID()

Retrieves Compound Graphic Instance ID. A number that identifies the Compound Graphic described in this Item. The value shall be unique within this SOP instance.

Returns:

long - value of Compound Graphic Instance ID.

setCompoundGraphicUnits

public void setCompoundGraphicUnits(EnumCompoundGraphicUnits enumCompoundGraphicUnits)

Sets Compound Graphic Units. Type of dimension used in attributes for the Compound Graphic when specifying distances and locations. Defined Terms: 1) PIXEL. 2) DISPLAY.

Parameters:

enumCompoundGraphicUnits - enum value of Compound Graphic Units.

getCompoundGraphicUnits

public java.lang.String getCompoundGraphicUnits()

Return Compound Graphic Units. Type of dimension used in attributes for the Compound Graphic when specifying distances and locations.

Returns:

String - value of Compound Graphic Units.

setGraphicDimensions

public void setGraphicDimensions(short shGraphicDimensions)

Sets Graphic Dimensions

Parameters:

shGraphicDimensions - short value of Graphic Dimensions

getGraphicDimensions

public short getGraphicDimensions()

Retrieves Graphic Dimensions

Returns:

short - short value of Graphic Dimensions

setNumberofGraphicPoints

public void setNumberofGraphicPoints(short shNumberofGraphicPoints)

Sets Number of Graphic Points

Parameters:

shNumberofGraphicPoints - short value of Number of Graphic Points

getNumberofGraphicPoints

public short getNumberofGraphicPoints()

Retrieves Number of Graphic Points

Returns:

short - short value of Number of Graphic Points

setGraphicData

public void setGraphicData(float fGraphicData)

Sets the Graphic Data. Numerical data Items that specify this Compound Graphic (points, vectors and scalars).

Parameters:

fGraphicData - Float value of Graphic Data

getGraphicData

public float getGraphicData()

Retrieves the Graphic Data. Numerical data Items that specify this Compound Graphic (points, vectors and scalars).

Returns:

float - Float value of the Graphic Data

setCompoundGraphicType

public void setCompoundGraphicType(EnumCompoundGraphicType enumCompoundGraphicType)

Sets type of Compound Graphic. Defined Terms: 1) MULTILINE. 2) INFINITELINE. 3) CUTLINE 4) RANGELINE. 5) RULER. 6) AXIS. 7) CROSSHAIR. 8) ARROW. 9) RECTANGLE. 10) ELLIPSE.

Parameters:

enumCompoundGraphicType - enum value of Compound Graphic Type.

getCompoundGraphicType

public java.lang.String getCompoundGraphicType()

Return type of Compound Graphic.

Returns:

String - value of Compound Graphic Type.

setRotationAngle

public void setRotationAngle(double dblRotationAngle)

Sets the Rotation Angle. The rotation of this Compound Graphic in degrees. Value shall be in degrees,between 0 and 360.

Parameters:

dblRotationAngle - Double value of Rotation Angle

getRotationAngle

public double getRotationAngle()

Retrieves the Rotation Angle. The rotation of this Compound Graphic in degrees. Value shall be in degrees,between 0 and 360.

Returns:

double - double value of Rotation Angle

setRotationPoint

public void setRotationPoint(float fRotationPoint)

Sets the Rotation Point. The rotation point of this Compound Graphic.

Parameters:

fRotationPoint - Float value of the Rotation Point

getRotationPoint

public float getRotationPoint()

Retrieves the Rotation Point. The rotation point of this Compound Graphic.

Returns:

float - Float value of the Rotation Point

setGapLength

public void setGapLength(float fGapLength)

Sets the Gap Length.

Parameters:

fGapLength - Float value of the Gap Length

getGapLength

public float getGapLength()

Retrieves the Gap Length.

Returns:

float - Float value of the Gap Length

setDiameterofVisibility

public void setDiameterofVisibility(float fDiameterofVisibility)

Sets the Diameter of Visibility.

Parameters:

fDiameterofVisibility - Float value of the Diameter of Visibility

getDiameterofVisibility

public float getDiameterofVisibility()

Retrieves the Diameter of Visibility.

Returns:

float - Float value of the Diameter of Visibility

getMajorTicksSequence

public MajorTicksSequence getMajorTicksSequence()

Retrieves pre-initialized object of Major Ticks 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:

MajorTicksSequence - instance of MajorTicksSequence.

setTickAlignment

public void setTickAlignment(EnumTickAlignment enumTickAlignment)

Sets Tick Alignment. The alignment of the ticks with respect to the line. Defined Terms: 1) BOTTOM. 2) CENTER. 3) TOP.

Parameters:

enumTickAlignment - enum value of Tick Alignment.

getTickAlignment

public java.lang.String getTickAlignment()

Return type of Tick Alignment. The alignment of the ticks with respect to the line.

Returns:

String - value of Tick Alignment.

setTickLabelAlignment

public void setTickLabelAlignment(EnumTickLabelAlignment enumTickLabelAlignment)

Sets Tick Label Alignment. The alignment of the label with respect to the tick. Defined Terms: 1) BOTTOM. 2) TOP.

Parameters:

enumTickLabelAlignment - enum value of Tick Label Alignment.

getTickLabelAlignment

public java.lang.String getTickLabelAlignment()

Return type of Tick Label Alignment. The alignment of the label with respect to the tick.

Returns:

String - value of Tick Label Alignment.

setShowTickLabel

public void setShowTickLabel(EnumShowTickLabel enumShowTickLabel)

Sets Show Tick Label. Indicates whether the tick label should be initially visible. Defined Terms: 1) Y. 2) N.

Parameters:

enumShowTickLabel - enum value of Show Tick Label.

getShowTickLabel

public java.lang.String getShowTickLabel()

Return type of Show Tick Label. Indicates whether the tick label should be initially visible.

Returns:

String - value of Show Tick Label.

setGraphicFilled

public void setGraphicFilled(EnumGraphicFilled enumGraphicFilled)

Sets Graphic Filled. Indicates whether or not the Compound Graphics is displayed as filled. Defined Terms: 1) Y. 2) N.

Parameters:

enumGraphicFilled - enum value of Graphic Filled.

getGraphicFilled

public java.lang.String getGraphicFilled()

Return type of Graphic Filled. Indicates whether or not the Compound Graphics is displayed as filled.

Returns:

String - value of Graphic Filled.

setGraphicGroupID

public void setGraphicGroupID(int iGraphicGroupID)

Sets Graphic Group ID. A number that defines the corresponding group object in the Graphic GroupSequence (0070,0234).

Parameters:

iGraphicGroupID - long value of Graphic Group ID.

getGraphicGroupID

public int getGraphicGroupID()

Retrieves Graphic Group ID. A number that defines the corresponding group object in the Graphic GroupSequence (0070,0234).

Returns:

long - value of Graphic Group ID.