cdac.medinfo.sdk.dcm30_04.baselibs

Class SurfaceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.SurfaceSequenceItem

All Implemented Interfaces:

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

public class SurfaceSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Surface Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFiniteVolume() Return type of Finite Volume.
java.lang.String	getManifold() Return type of Manifold.
short	getRecommendedDisplayCIELabValue() Retrieves Recommended Display CIELab Value.
short	getRecommendedDisplayGrayscaleValue() Retrieves Recommended Display Grayscale Value.
float	getRecommendedLineThickness() Retrieves the Recommended Line Thickness.
float	getRecommendedPointRadius() Retrieves the Recommended Point Radius.
float	getRecommendedPresentationOpacity() Retrieves the Recommended Presentation Opacity.
java.lang.String	getRecommendedPresentationType() Return type of Recommended Presentation.
java.lang.String	getSurfaceComments() Retrieves Surface Comments.
SurfaceMeshPrimitivesSequence	getSurfaceMeshPrimitivesSequence() Retrieves pre-initialized object of Surface Mesh Primitives 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.
int	getSurfaceNumber() Retrieves Surface Number.
SurfacePointsNormalsSequence	getSurfacePointsNormalsSequence() Retrieves pre-initialized object of Surface Points Normals 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.
SurfacePointsSequence	getSurfacePointsSequence() Retrieves pre-initialized object of Surface Points 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.
java.lang.String	getSurfaceProcessing() Return Surface Processing.
SurfaceProcessingAlgorithmIdentificationSequence	getSurfaceProcessingAlgorithmIdentificationSequence() Retrieves pre-initialized object of Surface Processing Algorithm Identification 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.
java.lang.String	getSurfaceProcessingDescription() Return Surface Processing Description.
float	getSurfaceProcessingRatio() Retrieves the Surface Processing Ratio.
void	setFiniteVolume(EnumFiniteVolume enumFiniteVolume) Sets Finite Volume.
void	setManifold(EnumManifold enumManifold) Sets Manifold.
void	setRecommendedDisplayCIELabValue(short shRecommendedDisplayCIELabValue) Sets Recommended Display CIELab Value
void	setRecommendedDisplayGrayscaleValue(short shRecommendedDisplayGrayscaleValue) Sets Recommended Display Grayscale Value
void	setRecommendedLineThickness(float fRecommendedLineThickness) Sets the Recommended Line Thickness.
void	setRecommendedPointRadius(float fRecommendedPointRadius) Sets the Recommended Point Radius.
void	setRecommendedPresentationOpacity(float fRecommendedPresentationOpacity) Sets the Recommended Presentation Opacity.
void	setRecommendedPresentationType(EnumRecommendedPresentationType enumRecommendedPresentationType) Sets type of Recommended Presentation.
void	setSurfaceComments(java.lang.String strSurfaceComments) Sets Surface Comments.
void	setSurfaceNumber(int iSurfaceNumber) Sets Surface Number.
void	setSurfaceProcessing(EnumSurfaceProcessing enumSurfaceProcessing) Sets Surface Processing.
void	setSurfaceProcessingDescription(java.lang.String strSurfaceProcessingDescription) Sets Surface Processing Description.
void	setSurfaceProcessingRatio(float fSurfaceProcessingRatio) Sets the Surface Processing Ratio.
boolean	validateForModule() Validates all the attributes in SurfaceSequenceItem 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 SurfaceSequenceItem 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 Conditional element fails.

setSurfaceNumber

public void setSurfaceNumber(int iSurfaceNumber)

Sets Surface Number. Identification number of the surface. Uniquely identifies a surface within this SOP instance. Shall start at a value of 1, and increase monotonically by 1.

Parameters:

iSurfaceNumber - long value of Surface Number.

getSurfaceNumber

public int getSurfaceNumber()

Retrieves Surface Number.

Returns:

long - value of Surface Number.

setSurfaceComments

public void setSurfaceComments(java.lang.String strSurfaceComments)

Sets Surface Comments.

Parameters:

strSurfaceComments - String value of Surface Comments.

getSurfaceComments

public java.lang.String getSurfaceComments()

Retrieves Surface Comments.

Returns:

String - value of Surface Comments.

setSurfaceProcessing

public void setSurfaceProcessing(EnumSurfaceProcessing enumSurfaceProcessing)

Sets Surface Processing. Defined Terms: 1) YES. 2) NO.

Parameters:

enumSurfaceProcessing - enum value of Surface Processing.

getSurfaceProcessing

public java.lang.String getSurfaceProcessing()

Return Surface Processing.

Returns:

String - value of Surface Processing.

setSurfaceProcessingRatio

public void setSurfaceProcessingRatio(float fSurfaceProcessingRatio)

Sets the Surface Processing Ratio.

Parameters:

fSurfaceProcessingRatio - Float value of the Surface Processing Ratio.

getSurfaceProcessingRatio

public float getSurfaceProcessingRatio()

Retrieves the Surface Processing Ratio.

Returns:

float - Float value of the Surface Processing Ratio.

setSurfaceProcessingDescription

public void setSurfaceProcessingDescription(java.lang.String strSurfaceProcessingDescription)

Sets Surface Processing Description.

Parameters:

strSurfaceProcessingDescription - String value of Surface Processing Description.

getSurfaceProcessingDescription

public java.lang.String getSurfaceProcessingDescription()

Return Surface Processing Description.

Returns:

String - value of Surface Processing Description.

getSurfaceProcessingAlgorithmIdentificationSequence

public SurfaceProcessingAlgorithmIdentificationSequence getSurfaceProcessingAlgorithmIdentificationSequence()

Retrieves pre-initialized object of Surface Processing Algorithm Identification 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:

SurfaceProcessingAlgorithmIdentificationSequence - instance of SurfaceProcessingAlgorithmIdentificationSequence.

setRecommendedDisplayGrayscaleValue

public void setRecommendedDisplayGrayscaleValue(short shRecommendedDisplayGrayscaleValue)

Sets Recommended Display Grayscale Value

Parameters:

shRecommendedDisplayGrayscaleValue - short value of Recommended Display Grayscale Value

getRecommendedDisplayGrayscaleValue

public short getRecommendedDisplayGrayscaleValue()

Retrieves Recommended Display Grayscale Value.

Returns:

short - short value of Recommended Display Grayscale Value.

setRecommendedDisplayCIELabValue

public void setRecommendedDisplayCIELabValue(short shRecommendedDisplayCIELabValue)

Sets Recommended Display CIELab Value

Parameters:

shRecommendedDisplayCIELabValue - short value of Recommended Display CIELab Value

getRecommendedDisplayCIELabValue

public short getRecommendedDisplayCIELabValue()

Retrieves Recommended Display CIELab Value.

Returns:

short - short value of Recommended Display CIELab Value.

setRecommendedPresentationOpacity

public void setRecommendedPresentationOpacity(float fRecommendedPresentationOpacity)

Sets the Recommended Presentation Opacity.

Parameters:

fRecommendedPresentationOpacity - Float value of the Recommended Presentation Opacity.

getRecommendedPresentationOpacity

public float getRecommendedPresentationOpacity()

Retrieves the Recommended Presentation Opacity.

Returns:

float - Float value of the Recommended Presentation Opacity.

setRecommendedPresentationType

public void setRecommendedPresentationType(EnumRecommendedPresentationType enumRecommendedPresentationType)

Sets type of Recommended Presentation. Defined Terms: 1) SURFACE. 2) WIREFRAME. 3) POINTS

Parameters:

enumRecommendedPresentationType - enum value of Recommended Presentation Type.

getRecommendedPresentationType

public java.lang.String getRecommendedPresentationType()

Return type of Recommended Presentation.

Returns:

String - value of Recommended Presentation Type.

setRecommendedPointRadius

public void setRecommendedPointRadius(float fRecommendedPointRadius)

Sets the Recommended Point Radius.

Parameters:

fRecommendedPointRadius - Float value of the Recommended Point Radius

getRecommendedPointRadius

public float getRecommendedPointRadius()

Retrieves the Recommended Point Radius.

Returns:

float - Float value of the Recommended Point Radius

setRecommendedLineThickness

public void setRecommendedLineThickness(float fRecommendedLineThickness)

Sets the Recommended Line Thickness.

Parameters:

fRecommendedLineThickness - Float value of the Recommended Line Thickness

getRecommendedLineThickness

public float getRecommendedLineThickness()

Retrieves the Recommended Line Thickness.

Returns:

float - Float value of the Recommended Line Thickness

setFiniteVolume

public void setFiniteVolume(EnumFiniteVolume enumFiniteVolume)

Sets Finite Volume. Defined Terms: 1) YES. 2) NO. 3) UNKNOWN.

Parameters:

enumFiniteVolume - enum value of Finite Volume.

getFiniteVolume

public java.lang.String getFiniteVolume()

Return type of Finite Volume.

Returns:

String - value of Finite Volume.

setManifold

public void setManifold(EnumManifold enumManifold)

Sets Manifold. Defined Terms: 1) YES. 2) NO. 3) UNKNOWN.

Parameters:

enumManifold - enum value of Manifold.

getManifold

public java.lang.String getManifold()

Return type of Manifold.

Returns:

String - value of Manifold.

getSurfacePointsSequence

public SurfacePointsSequence getSurfacePointsSequence()

Retrieves pre-initialized object of Surface Points 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:

SurfacePointsSequence - instance of Surface Points Sequence.

getSurfacePointsNormalsSequence

public SurfacePointsNormalsSequence getSurfacePointsNormalsSequence()

Retrieves pre-initialized object of Surface Points Normals 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:

SurfacePointsNormalsSequence - instance of Surface Points Normals Sequence.

getSurfaceMeshPrimitivesSequence

public SurfaceMeshPrimitivesSequence getSurfaceMeshPrimitivesSequence()

Retrieves pre-initialized object of Surface Mesh Primitives 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:

SurfaceMeshPrimitivesSequence - instance of Surface Mesh Primitives Sequence.