cdac.medinfo.sdk.dcm30_04.baselibs

Class PhaseInformationSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.PhaseInformationSequenceItem

All Implemented Interfaces:

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

public class PhaseInformationSequenceItem
extends Item

This item class contains methods to set,get and validate attributes in Phase Information Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActualFrameDuration() Retrieves Nominal time of acquisition per individual frame, in msec.
short	getNumberOfFramesInPhase() Retrieves Number of frames in this phase.
java.lang.String	getPauseBetweenFrames() Retrieves time paused between each frame of this phase (in msec).
java.lang.String	getPhaseDelay() Retrieves time paused between the last frame of the previous phase and the first frame of this phase, in msec.
java.lang.String[]	getTriggerVector() Return an array of trigger times when gating information is acquired simultaneously with the dynamic image data.
void	setActualFrameDuration(java.lang.String strActualFrameDuration) Sets Nominal time of acquisition per individual frame, in msec.
void	setNumberOfFramesInPhase(short shNumberOfFramesInPhase) Sets Number of frames in this phase.
short	setNumberOfTriggersInPhase() Return number of entries in the Trigger Vector.
void	setNumberOfTriggersInPhase(short shNumberOfTriggersInPhase) Sets the number of entries in the Trigger Vector (0054,0210) for this phase.
void	setPauseBetweenFrames(java.lang.String strPauseBetweenFrames) Sets time paused between each frame of this phase (in msec).
void	setPhaseDelay(java.lang.String strPhaseDelay) Sets time paused between the last frame of the previous phase and the first frame of this phase, in msec.
java.lang.String	setPhaseDescription() Retrieve description of this phase of the Dynamic image.
void	setPhaseDescription(EnumPhaseDescription enumPhaseDescription) Sets description of this phase of the Dynamic image.Defined Terms:FLOW, WASHOUT, UPTAKE,EMPTYING,EXCRETION
void	setTriggerVector(java.lang.String[] arrStrTriggerVector) Sets an array of trigger times when gating information is acquired simultaneously with the dynamic image data.
boolean	validateForModule() Validates all the attributes in PhaseInformationSequenceItem 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 PhaseInformationSequenceItem 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.

setPhaseDelay

public void setPhaseDelay(java.lang.String strPhaseDelay)

Sets time paused between the last frame of the previous phase and the first frame of this phase, in msec. Required if a sequence Item is present.

Parameters:

strPhaseDelay - String value of Phase Delay.

getPhaseDelay

public java.lang.String getPhaseDelay()

Retrieves time paused between the last frame of the previous phase and the first frame of this phase, in msec.

Returns:

String - value of Phase Delay.

setActualFrameDuration

public void setActualFrameDuration(java.lang.String strActualFrameDuration)

Sets Nominal time of acquisition per individual frame, in msec. Required if a sequence Item is present.

Parameters:

strActualFrameDuration - String value of Actual Frame Duration.

getActualFrameDuration

public java.lang.String getActualFrameDuration()

Retrieves Nominal time of acquisition per individual frame, in msec.

Returns:

String - value of Actual Frame Duration.

setPauseBetweenFrames

public void setPauseBetweenFrames(java.lang.String strPauseBetweenFrames)

Sets time paused between each frame of this phase (in msec). Required if a sequence Item is present.

Parameters:

strPauseBetweenFrames - String value of Pause Between Frames.

getPauseBetweenFrames

public java.lang.String getPauseBetweenFrames()

Retrieves time paused between each frame of this phase (in msec).

Returns:

String - value of Pause Between Frames.

setNumberOfFramesInPhase

public void setNumberOfFramesInPhase(short shNumberOfFramesInPhase)

Sets Number of frames in this phase. Required if a sequence Item is present.

Parameters:

shNumberOfFramesInPhase - short value of Number Of Frames in Phase.

getNumberOfFramesInPhase

public short getNumberOfFramesInPhase()

Retrieves Number of frames in this phase.

Returns:

short - short value of Number Of Frames in Phase.

setTriggerVector

public void setTriggerVector(java.lang.String[] arrStrTriggerVector)

Sets an array of trigger times when gating information is acquired simultaneously with the dynamic image data.

Parameters:

arrStrTriggerVector - String array of Trigger Vector.

getTriggerVector

public java.lang.String[] getTriggerVector()

Return an array of trigger times when gating information is acquired simultaneously with the dynamic image data.

Returns:

String[] - String array of Trigger Vector.

setNumberOfTriggersInPhase

public void setNumberOfTriggersInPhase(short shNumberOfTriggersInPhase)

Sets the number of entries in the Trigger Vector (0054,0210) for this phase. Required if Trigger Vector (0054,0210) is present.

Parameters:

shNumberOfTriggersInPhase - short value of Number Of Triggers in Phase.

setNumberOfTriggersInPhase

public short setNumberOfTriggersInPhase()

Return number of entries in the Trigger Vector.

Returns:

short - short value of Number Of Triggers in Phase.

setPhaseDescription

public void setPhaseDescription(EnumPhaseDescription enumPhaseDescription)

Sets description of this phase of the Dynamic image.Defined Terms:FLOW, WASHOUT, UPTAKE,EMPTYING,EXCRETION

Parameters:

enumPhaseDescription - Enum value of Phase Description.

setPhaseDescription

public java.lang.String setPhaseDescription()

Retrieve description of this phase of the Dynamic image.

Returns:

String - value of Phase Description.