cdac.medinfo.sdk.dcm30_04.baselibs

Class HPGLDocumentSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.CodeSequenceMacroDependentItem

cdac.medinfo.sdk.dcm30_04.baselibs.HPGLDocumentSequenceItem

All Implemented Interfaces:

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

public class HPGLDocumentSequenceItem
extends CodeSequenceMacroDependentItem

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getBoundingRectangle() Retrieves the Bounding Rectangle
short	getHPGLContourPenNumber() Retrieves HPGL Contour Pen Number
ISingleCollection<byte[]>	getHPGLDocument() Retrieves HPGL document as a byte stream
short	getHPGLDocumentID() Retrieves HPGL Document ID
java.lang.String	getHPGLDocumentLabel() Return HPGL Document Label
double	getHPGLDocumentScaling() Retrieves HPGL Document Scaling
HPGLPenSequence	getHPGLPenSequence() Retrieves pre-initialized object of HPGLPenSequence.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.
double[]	getRecommendedRotationPoint() Retrieves the Recommended Rotation Point
ViewOrientationCodeSequence	getViewOrientationCodeSequence() Retrieves pre-initialized object of ViewOrientationCodeSequence.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.
double[]	getViewOrientationModifier() Retrieves the View Orientation Modifier
void	setBoundingRectangle(double[] dblArrBoundingRectangle) Sets the Bounding Rectangle
void	setHPGLContourPenNumber(short shHPGLContourPenNumber) Sets HPGL Contour Pen Number
void	setHPGLDocument(ISingleCollection<byte[]> vectHPGLDocument) Sets the HPGL document as a byte stream
void	setHPGLDocumentIDshort(short shHPGLDocumentID) Sets HPGL Document ID
void	setHPGLDocumentLabel(java.lang.String strHPGLDocumentLabel) Sets HPGL Document Label.
void	setHPGLDocumentScaling(double dblHPGLDocumentScaling) Sets the HPGL Document Scaling.
void	setRecommendedRotationPoint(double[] dblArrRecommendedRotationPoint) Sets the Recommended Rotation Point
void	setViewOrientationModifier(double[] dblArrViewOrientationModifier) Sets the View Orientation Modifier
boolean	validateForModule() Validates all the attributes in HPGLDocumentSequenceItem that are present in the DataSet

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

getCodeSequenceMacro

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 HPGLDocumentSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class CodeSequenceMacroDependentItem

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setHPGLDocumentIDshort

public void setHPGLDocumentIDshort(short shHPGLDocumentID)

Sets HPGL Document ID

Parameters:

shHPGLDocumentID - short value of HPGL Document ID

getHPGLDocumentID

public short getHPGLDocumentID()

Retrieves HPGL Document ID

Returns:

short - short value of HPGL Document ID

setHPGLDocumentLabel

public void setHPGLDocumentLabel(java.lang.String strHPGLDocumentLabel)

Sets HPGL Document Label.

Parameters:

strHPGLDocumentLabel - String value of HPGLDocumentLabel

getHPGLDocumentLabel

public java.lang.String getHPGLDocumentLabel()

Return HPGL Document Label

Returns:

String - value of HPGLDocumentLabel

getViewOrientationCodeSequence

public ViewOrientationCodeSequence getViewOrientationCodeSequence()

Retrieves pre-initialized object of ViewOrientationCodeSequence.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:

ViewOrientationCodeSequence - instance of ViewOrientationCodeSequence.

setViewOrientationModifier

public void setViewOrientationModifier(double[] dblArrViewOrientationModifier)

Sets the View Orientation Modifier

Parameters:

dblArrViewOrientationModifier - Double value of ViewOrientationModifier

getViewOrientationModifier

public double[] getViewOrientationModifier()

Retrieves the View Orientation Modifier

Returns:

double - double value of ViewOrientationModifier

setHPGLDocumentScaling

public void setHPGLDocumentScaling(double dblHPGLDocumentScaling)

Sets the HPGL Document Scaling.

Parameters:

dblHPGLDocumentScaling - Double value of HPGLDocumentScaling

getHPGLDocumentScaling

public double getHPGLDocumentScaling()

Retrieves HPGL Document Scaling

Returns:

double - double value of HPGLDocumentScaling

setHPGLDocument

public void setHPGLDocument(ISingleCollection<byte[]> vectHPGLDocument)

Sets the HPGL document as a byte stream

Parameters:

vectHPGLDocument - collection of byte array of HPGL document

getHPGLDocument

public ISingleCollection<byte[]> getHPGLDocument()

Retrieves HPGL document as a byte stream

Returns:

ISingleCollection - collection of byte array of HPGL document

setHPGLContourPenNumber

public void setHPGLContourPenNumber(short shHPGLContourPenNumber)

Sets HPGL Contour Pen Number

Parameters:

shHPGLContourPenNumber - short value of HPGL Contour Pen Number

getHPGLContourPenNumber

public short getHPGLContourPenNumber()

Retrieves HPGL Contour Pen Number

Returns:

short - short value of HPGL Contour Pen Number

getHPGLPenSequence

public HPGLPenSequence getHPGLPenSequence()

Retrieves pre-initialized object of HPGLPenSequence.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:

HPGLPenSequence - instance of HPGLPenSequence.

setRecommendedRotationPoint

public void setRecommendedRotationPoint(double[] dblArrRecommendedRotationPoint)

Sets the Recommended Rotation Point

Parameters:

dblArrRecommendedRotationPoint - Double value of Recommended Rotation Point

getRecommendedRotationPoint

public double[] getRecommendedRotationPoint()

Retrieves the Recommended Rotation Point

Returns:

double - double value of Recommended Rotation Point

setBoundingRectangle

public void setBoundingRectangle(double[] dblArrBoundingRectangle)

Sets the Bounding Rectangle

Parameters:

dblArrBoundingRectangle - Double value of BoundingRectangle

getBoundingRectangle

public double[] getBoundingRectangle()

Retrieves the Bounding Rectangle

Returns:

double - double value of BoundingRectangle