cdac.medinfo.sdk.dcm30_04.baselibs

Class TimeBasedImageSetsSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.TimeBasedImageSetsSequenceItem

All Implemented Interfaces:

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

public class TimeBasedImageSetsSequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of Time Based Image Sets Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
AbstractPriorCodeSequence	getAbstractPriorCodeSequence() Identifies a prior image set using coded terminology.
short[]	getAbstractPriorValue() Returns the format of the LUT Data in this Sequence.
java.lang.String	getImageSetLabel() Return image set defined identifier for ImageSetLabel.
short	getImageSetNumber() Retrieves Number of significant bits with increasing value
java.lang.String	getImageSetSelectorCategory() Retrieves type of the Image Set Selector Category
short[]	getRelativeTime() Retrieves get Relative Time.
java.lang.String	getRelativeTimeUnits() Retrieves type of the value encoded in this Item
void	setAbstractPriorValue(short[] sAbstractPriorValue) Exactly two integer values, indicating the range of prior studies to include.
void	setImageSetLabel(java.lang.String strImageSetLabel) Sets ImageSetLabel.
void	setImageSetNumber(short imageSetNumber) Sets Number of significant bits a monotonically increasing integer
void	setImageSetSelectorCategory(EnumImageSetSelectorCategory enumImageSetSelectorCategory) Sets the Value Type Defined in category of the Time Based Image Set selector
void	setRelativeTime(short[] arrRelativeTime)
void	setRelativeTimeUnits(EnumRelativeTimeUnits enumRelativeTimeUnits) Sets the Value Type Defined in Terms of TIME
boolean	validateForModule() Validates the Item for the rules of module.

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

Description copied from class: Item

Validates the Item for the rules of module. Specific modules are expected to override the validation method

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - status indicating success/failure

Throws:

InvalidItemException - Signals Item Validation is failed.

setImageSetNumber

public void setImageSetNumber(short imageSetNumber)

Sets Number of significant bits a monotonically increasing integer

Parameters:

imageSetNumber - short value of Number of significant bits

getImageSetNumber

public short getImageSetNumber()

Retrieves Number of significant bits with increasing value

Returns:

value of Number of significant bits

setImageSetSelectorCategory

public void setImageSetSelectorCategory(EnumImageSetSelectorCategory enumImageSetSelectorCategory)

Sets the Value Type Defined in category of the Time Based Image Set selector

Parameters:

enumImageSetSelectorCategory - Specifies type of the value encoded in this Item

getImageSetSelectorCategory

public java.lang.String getImageSetSelectorCategory()

Retrieves type of the Image Set Selector Category

Returns:

String - Type of the value encoded in this Item

setRelativeTime

public void setRelativeTime(short[] arrRelativeTime)

getRelativeTime

public short[] getRelativeTime()

Retrieves get Relative Time.

Returns:

short Array Relative Time Units.

setRelativeTimeUnits

public void setRelativeTimeUnits(EnumRelativeTimeUnits enumRelativeTimeUnits)

Sets the Value Type Defined in Terms of TIME

Parameters:

strRelativeTimeUnits - Specifies type of the value encoded in this Item

getRelativeTimeUnits

public java.lang.String getRelativeTimeUnits()

Retrieves type of the value encoded in this Item

Returns:

String - Relative Time Units in this Item

setAbstractPriorValue

public void setAbstractPriorValue(short[] sAbstractPriorValue)

Exactly two integer values, indicating the range of prior studies to include. Each value shall be greater than zero, where 1 indicates the most recent prior and higher values indicate successively older priors.

Parameters:

sAbstractPriorValue - short array of integer value.

getAbstractPriorValue

public short[] getAbstractPriorValue()

Returns the format of the LUT Data in this Sequence.

Returns:

short[] - short array of Abstract Prior Value.

getAbstractPriorCodeSequence

public AbstractPriorCodeSequence getAbstractPriorCodeSequence()

Identifies a prior image set using coded terminology. Only a single Item shall be included in this Sequence. and then returns the object of sequence.

Returns:

AbstractPriorCodeSequence - instance of AbstractPriorCodeSequence.

setImageSetLabel

public void setImageSetLabel(java.lang.String strImageSetLabel)

Sets ImageSetLabel.

Parameters:

strImageSetLabel - String value.

getImageSetLabel

public java.lang.String getImageSetLabel()

Return image set defined identifier for ImageSetLabel.

Returns:

String - value of Image Set Label.