cdac.medinfo.sdk.dcm30_04.baselibs

Class FrameDisplaySequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.FrameDisplaySequenceItem

All Implemented Interfaces:

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

public class FrameDisplaySequenceItem
extends Item

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

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
float	getDisplayFilterPercentage() Retrieves the Display Filter Percentage.
float	getMaskVisibilityPercentage() Retrieves the Mask Visibility Percentage.
float	getRecommendedDisplayFrameRateinFloat() Retrieves the Recommended Display Frame Rate in Float.
java.lang.String	getRecommendedViewingMode() Return type of Recommended Viewing Mode.
java.lang.String	getSkipFrameRangeFlag() Return type of Skip Frame Range Flag.
java.lang.String	getStartTrim() Retrieves Start Trim.
java.lang.String	getStopTrim() Retrieves Stop Trim.
void	setDisplayFilterPercentage(float fDisplayFilterPercentage) Sets the Display Filter Percentage.
void	setMaskVisibilityPercentage(float fMaskVisibilityPercentage) Sets the Mask Visibility Percentage.
void	setRecommendedDisplayFrameRateinFloat(float fRecommendedDisplayFrameRateinFloat) Sets the Recommended Display Frame Rate in Float.
void	setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode) Sets Recommended Viewing Mode.
void	setSkipFrameRangeFlag(EnumSkipFrameRangeFlag enumSkipFrameRangeFlag) Sets Skip Frame Range Flag.
void	setStartTrim(java.lang.String strStartTrim) Sets Start Trim.
void	setStopTrim(java.lang.String strStopTrim) Sets Stop Trim.
boolean	validateForModule() Validates all the attributes in Frame Display 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 Frame Display 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.

setStartTrim

public void setStartTrim(java.lang.String strStartTrim)

Sets Start Trim. The Frame Number of the first frame of the set of frames to be displayed in this Item.

Parameters:

strStartTrim - String value of Start Trim.

getStartTrim

public java.lang.String getStartTrim()

Retrieves Start Trim. The Frame Number of the first frame of the set of frames to be displayed in this Item.

Returns:

String - value of Start Trim.

setStopTrim

public void setStopTrim(java.lang.String strStopTrim)

Sets Stop Trim. The Frame Number of the last frame of the set of frames to be displayed in this Item.

Parameters:

strStopTrim - String value of Stop Trim.

getStopTrim

public java.lang.String getStopTrim()

Retrieves Stop Trim. The Frame Number of the last frame of the set of frames to be displayed in this Item.

Returns:

String - value of Stop Trim.

setSkipFrameRangeFlag

public void setSkipFrameRangeFlag(EnumSkipFrameRangeFlag enumSkipFrameRangeFlag)

Sets Skip Frame Range Flag. Defined Terms: 1) DISPLAY. 2) SKIP.

Parameters:

enumSkipFrameRangeFlag - enum value of Skip Frame Range Flag.

getSkipFrameRangeFlag

public java.lang.String getSkipFrameRangeFlag()

Return type of Skip Frame Range Flag.

Returns:

String - value of Skip Frame Range Flag.

setRecommendedDisplayFrameRateinFloat

public void setRecommendedDisplayFrameRateinFloat(float fRecommendedDisplayFrameRateinFloat)

Sets the Recommended Display Frame Rate in Float.

Parameters:

fRecommendedDisplayFrameRateinFloat - Float value of Recommended Display Frame Rate in Float

getRecommendedDisplayFrameRateinFloat

public float getRecommendedDisplayFrameRateinFloat()

Retrieves the Recommended Display Frame Rate in Float.

Returns:

float - Float value of the Recommended Display Frame Rate in Float

setRecommendedViewingMode

public void setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode)

Sets Recommended Viewing Mode. Specifies the recommended viewing protocol(s). Defined Terms: 1) SUB. 2) NAT.

Parameters:

enumRecommendedViewingMode - enum value of Setup Device Type.

getRecommendedViewingMode

public java.lang.String getRecommendedViewingMode()

Return type of Recommended Viewing Mode. Specifies the recommended viewing protocol(s).

Returns:

String - value of Recommended Viewing Mode.

setDisplayFilterPercentage

public void setDisplayFilterPercentage(float fDisplayFilterPercentage)

Sets the Display Filter Percentage.

Parameters:

fDisplayFilterPercentage - Float value of the Display Filter Percentage

getDisplayFilterPercentage

public float getDisplayFilterPercentage()

Retrieves the Display Filter Percentage.

Returns:

float - Float value of the Display Filter Percentage

setMaskVisibilityPercentage

public void setMaskVisibilityPercentage(float fMaskVisibilityPercentage)

Sets the Mask Visibility Percentage.

Parameters:

fMaskVisibilityPercentage - Float value of the Mask Visibility Percentage

getMaskVisibilityPercentage

public float getMaskVisibilityPercentage()

Retrieves the Mask Visibility Percentage.

Returns:

float - Float value of the Mask Visibility Percentage