cdac.medinfo.sdk.dcm30_04.baselibs

Class RecordedChannelSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RecordedChannelSequenceItem

All Implemented Interfaces:

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

public class RecordedChannelSequenceItem
extends Item

This item class contains the methods to set, get and validate the attribute present in Recorded Channel Sequence Item.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
BrachyControlPointDeliveredSequence	getBrachyControlPointDeliveredSequence() Retrieves pre-initialized object of Brachy Control Point Delivered Sequence.
java.lang.String	getChannelLength() Retrieves Length of Channel (mm).
java.lang.String	getChannelNumber() Retrieves Identification number of the Channel.
java.lang.String	getDeliveredChannelTotalTime() Retrieves Total amount of time Delivered between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).
java.lang.String	getDeliveredNumberOfPulses() Retrieves Number of Pulses delivered per fraction for current Channel.
java.lang.String	getDeliveredPulseRepetitionInterval() Retrieves Pulse repetition interval (sec) Delivered for current Channel.
java.lang.String	getNumberOfControlPoints() Retrieves Number of control points in Channel.
PulseSpecificBrachyControlPointDeliveredSequence	getPulseSpecificBrachyControlPointDeliveredSequence() Retrieves pre-initialized object of Pulse Specific Brachy Control Point Delivered Sequence.
RecordedChannelShieldSequence	getRecordedChannelShieldSequence() Retrieves pre-initialized object of Recorded Channel Shield Sequence.
RecordedSourceApplicatorSequence	getRecordedSourceApplicatorSequence() Retrieves pre-initialized object of Recorded Source Applicator 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
ReferencedCalculatedDoseReferenceSequence	getReferencedCalculatedDoseReferenceSequence() Retrieves pre-initialized object of Referenced Calculated Dose Reference 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
ReferencedMeasuredDoseReferenceSequence	getReferencedMeasuredDoseReferenceSequence() Retrieves pre-initialized object of Referenced Measured Dose Reference 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	getReferencedSourceNumber() Retrieves referenced Source within the Recorded Source Sequence (3008,0100) for current Application Setup.
java.lang.String	getSafePositionExitDate() Retrieves Date on which the source(s) exited the safe.
java.lang.String	getSafePositionExitTime() Retrieves Time on which the source(s) exited the safe.
java.lang.String	getSafePositionReturnDate() Retrieves Date on which the source(s) returned to the safe.
java.lang.String	getSafePositionReturnTime() Retrieves Time on which the source(s) returned to the safe.
java.lang.String	getSourceMovementType() Retrieves Type of Source movement.
java.lang.String	getSpecifiedChannelTotalTime() Retrieves Total amount of time specified between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).
java.lang.String	getSpecifiedNumberOfPulses() Retrieves Number of Pulses specified per fraction for current Channel.
java.lang.String	getSpecifiedPulseRepetitionInterval() Retrieves Pulse repetition interval (sec) specified for current Channel.
java.lang.String	getTransferTubeLength() Retrieves Length of Transfer Tube of current afterloading Channel (mm).
java.lang.String	getTransferTubeNumber() Retrieves Identification number of the Transfer Tube.
void	setChannelLength(java.lang.String strChannelLength) Sets Length of Channel (mm).
void	setChannelNumber(java.lang.String strChannelNumber) Sets Identification number of the Channel.
void	setDeliveredChannelTotalTime(java.lang.String strDeliveredChannelTotalTime) Sets Total amount of time actually delivered between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).
void	setDeliveredNumberOfPulses(java.lang.String strDeliveredNumberOfPulses) Sets Number of Pulses actually delivered per fraction for current Channel.
void	setDeliveredPulseRepetitionInterval(java.lang.String strDeliveredPulseRepetitionInterval) Sets Pulse repetition interval (sec) actually delivered for current Channel.
void	setNumberOfControlPoints(java.lang.String strNumberOfControlPoints) Sets Number of control points in Channel.For an N-segment Channel there will be 2N or N+1 control points.
void	setReferencedSourceNumber(java.lang.String strReferencedSourceNumber) Uniquely identifies the referenced Source within the Recorded Source Sequence (3008,0100) for current Application Setup.
void	setSafePositionExitDate(java.lang.String strSafePositionExitDate) Sets Date on which the source(s) exited the safe.
void	setSafePositionExitTime(java.lang.String strSafePositionExitDate) Sets Time on which the source(s) exited the safe.
void	setSafePositionReturnDate(java.lang.String strSafePositionReturnDate) Sets Date on which the source(s) returned to the safe.
void	setSafePositionReturnTime(java.lang.String strSafePositionReturnTime) Sets Time on which the source(s) returned to the safe.
void	setSourceMovementType(EnumSourceMovementType enumSourceMovementType) Sets Type of Source movement.
void	setSpecifiedChannelTotalTime(java.lang.String strSpecifiedChannelTotalTime) Sets Total amount of time specified between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).
void	setSpecifiedNumberOfPulses(java.lang.String strSpecifiedNumberOfPulses) Sets Number of Pulses specified per fraction for current Channel.
void	setSpecifiedPulseRepetitionInterval(java.lang.String strSpecifiedPulseRepetitionInterval) Sets Pulse repetition interval (sec) specified for current Channel.
void	setTransferTubeLength(java.lang.String strTransferTubeLength) Sets Length of Transfer Tube of current afterloading Channel (mm).
void	setTransferTubeNumber(java.lang.String strTransferTubeNumber) Sets Identification number of the Transfer Tube.
boolean	validateForModule() Validates all the attributes in RecordedChannelSequenceItem 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

setChannelNumber

public void setChannelNumber(java.lang.String strChannelNumber)

Sets Identification number of the Channel. The value of Channel Number (300A,0282) shall be unique within the Application

Parameters:

strChannelNumber - String value of Channel Number.

getChannelNumber

public java.lang.String getChannelNumber()

Retrieves Identification number of the Channel.

Returns:

String - value of Identification number of the Channel.

setChannelLength

public void setChannelLength(java.lang.String strChannelLength)

Sets Length of Channel (mm).

Parameters:

strChannelLength - String value of Channel Length.

getChannelLength

public java.lang.String getChannelLength()

Retrieves Length of Channel (mm).

Returns:

String - value of Channel Length.

setSpecifiedChannelTotalTime

public void setSpecifiedChannelTotalTime(java.lang.String strSpecifiedChannelTotalTime)

Sets Total amount of time specified between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).

Parameters:

strSpecifiedChannelTotalTime - String value of Specified Channel Total Time.

getSpecifiedChannelTotalTime

public java.lang.String getSpecifiedChannelTotalTime()

Retrieves Total amount of time specified between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).

Returns:

String - value of Specified Channel Total Time.

setDeliveredChannelTotalTime

public void setDeliveredChannelTotalTime(java.lang.String strDeliveredChannelTotalTime)

Sets Total amount of time actually delivered between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).

Parameters:

strDeliveredChannelTotalTime - String value of Delivered Channel Total Time.

getDeliveredChannelTotalTime

public java.lang.String getDeliveredChannelTotalTime()

Retrieves Total amount of time Delivered between Control Point 0 and final Control Point of the Brachy Control Point Sequence (300A,02D0) for current Channel (sec).

Returns:

String - value of Delivered Channel Total Time.

setSourceMovementType

public void setSourceMovementType(EnumSourceMovementType enumSourceMovementType)

Sets Type of Source movement. Defined Terms: STEPWISE, FIXED, OSCILLATING, UNIDIRECTIONAL.

Parameters:

enumSourceMovementType - Enum value of Type of Source movement.

getSourceMovementType

public java.lang.String getSourceMovementType()

Retrieves Type of Source movement.

Returns:

String - value of Source Movement Type.

setSpecifiedNumberOfPulses

public void setSpecifiedNumberOfPulses(java.lang.String strSpecifiedNumberOfPulses)

Sets Number of Pulses specified per fraction for current Channel.

Parameters:

strSpecifiedNumberOfPulses - String value of Specified Number of Pulses.

getSpecifiedNumberOfPulses

public java.lang.String getSpecifiedNumberOfPulses()

Retrieves Number of Pulses specified per fraction for current Channel.

Returns:

String - value of Specified Number of Pulses.

setDeliveredNumberOfPulses

public void setDeliveredNumberOfPulses(java.lang.String strDeliveredNumberOfPulses)

Sets Number of Pulses actually delivered per fraction for current Channel.

Parameters:

strDeliveredNumberOfPulses - String value of Delivered Number of Pulses.

getDeliveredNumberOfPulses

public java.lang.String getDeliveredNumberOfPulses()

Retrieves Number of Pulses delivered per fraction for current Channel.

Returns:

String - value of Delivered Number of Pulses.

setSpecifiedPulseRepetitionInterval

public void setSpecifiedPulseRepetitionInterval(java.lang.String strSpecifiedPulseRepetitionInterval)

Sets Pulse repetition interval (sec) specified for current Channel.

Parameters:

strSpecifiedPulseRepetitionInterval - String value of Specified Pulse Repetition Interval.

getSpecifiedPulseRepetitionInterval

public java.lang.String getSpecifiedPulseRepetitionInterval()

Retrieves Pulse repetition interval (sec) specified for current Channel.

Returns:

String - value of Specified Pulse Repetition Interval.

setDeliveredPulseRepetitionInterval

public void setDeliveredPulseRepetitionInterval(java.lang.String strDeliveredPulseRepetitionInterval)

Sets Pulse repetition interval (sec) actually delivered for current Channel.

Parameters:

strDeliveredPulseRepetitionInterval - String value of Delivered Pulse Repetition Interval.

getDeliveredPulseRepetitionInterval

public java.lang.String getDeliveredPulseRepetitionInterval()

Retrieves Pulse repetition interval (sec) Delivered for current Channel.

Returns:

String - value of Delivered Pulse Repetition Interval.

getReferencedMeasuredDoseReferenceSequence

public ReferencedMeasuredDoseReferenceSequence getReferencedMeasuredDoseReferenceSequence()

Retrieves pre-initialized object of Referenced Measured Dose Reference 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:

ReferencedMeasuredDoseReferenceSequence - instance of Referenced Measured Dose Reference Sequence.

getReferencedCalculatedDoseReferenceSequence

public ReferencedCalculatedDoseReferenceSequence getReferencedCalculatedDoseReferenceSequence()

Retrieves pre-initialized object of Referenced Calculated Dose Reference 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:

ReferencedCalculatedDoseReferenceSequence - instance of Referenced Calculated Dose Reference Sequence.

getRecordedSourceApplicatorSequence

public RecordedSourceApplicatorSequence getRecordedSourceApplicatorSequence()

Retrieves pre-initialized object of Recorded Source Applicator 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:

RecordedSourceApplicatorSequence - instance of Recorded Source Applicator Sequence.

setTransferTubeNumber

public void setTransferTubeNumber(java.lang.String strTransferTubeNumber)

Sets Identification number of the Transfer Tube.

Parameters:

strTransferTubeNumber - String value of Transfer Tube Number.

getTransferTubeNumber

public java.lang.String getTransferTubeNumber()

Retrieves Identification number of the Transfer Tube.

Returns:

String - value of Transfer Tube Number.

setTransferTubeLength

public void setTransferTubeLength(java.lang.String strTransferTubeLength)

Sets Length of Transfer Tube of current afterloading Channel (mm).

Parameters:

strTransferTubeLength - String value of Transfer Tube Length.

getTransferTubeLength

public java.lang.String getTransferTubeLength()

Retrieves Length of Transfer Tube of current afterloading Channel (mm).

Returns:

String - value of Transfer Tube Length.

getRecordedChannelShieldSequence

public RecordedChannelShieldSequence getRecordedChannelShieldSequence()

Retrieves pre-initialized object of Recorded Channel Shield 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:

RecordedChannelShieldSequence - instance of Recorded Channel Shield Sequence.

setReferencedSourceNumber

public void setReferencedSourceNumber(java.lang.String strReferencedSourceNumber)

Uniquely identifies the referenced Source within the Recorded Source Sequence (3008,0100) for current Application Setup.

Parameters:

strReferencedSourceNumber - String value of Referenced Source Number.

getReferencedSourceNumber

public java.lang.String getReferencedSourceNumber()

Retrieves referenced Source within the Recorded Source Sequence (3008,0100) for current Application Setup.

Returns:

String - value of Referenced Source Number.

setSafePositionExitDate

public void setSafePositionExitDate(java.lang.String strSafePositionExitDate)

Sets Date on which the source(s) exited the safe.

Parameters:

strSafePositionExitDate - String value of Safe Position Exit Date.

getSafePositionExitDate

public java.lang.String getSafePositionExitDate()

Retrieves Date on which the source(s) exited the safe.

Returns:

String - value of Safe Position Exit Date.

setSafePositionExitTime

public void setSafePositionExitTime(java.lang.String strSafePositionExitDate)

Sets Time on which the source(s) exited the safe.

Parameters:

strSafePositionExitDate - String value of Safe Position Exit Time.

getSafePositionExitTime

public java.lang.String getSafePositionExitTime()

Retrieves Time on which the source(s) exited the safe.

Returns:

String - value of Safe Position Exit Time.

setSafePositionReturnDate

public void setSafePositionReturnDate(java.lang.String strSafePositionReturnDate)

Sets Date on which the source(s) returned to the safe.

Parameters:

strSafePositionReturnDate - String value of Safe Position Return Date.

getSafePositionReturnDate

public java.lang.String getSafePositionReturnDate()

Retrieves Date on which the source(s) returned to the safe.

Returns:

String - value of Safe Position Return Date.

setSafePositionReturnTime

public void setSafePositionReturnTime(java.lang.String strSafePositionReturnTime)

Sets Time on which the source(s) returned to the safe.

Parameters:

strSafePositionReturnTime - String value of Safe Position Return Time.

getSafePositionReturnTime

public java.lang.String getSafePositionReturnTime()

Retrieves Time on which the source(s) returned to the safe.

Returns:

String - value of Safe Position Return Time.

setNumberOfControlPoints

public void setNumberOfControlPoints(java.lang.String strNumberOfControlPoints)

Sets Number of control points in Channel.For an N-segment Channel there will be 2N or N+1 control points.

Parameters:

strNumberOfControlPoints - String value of Number of Control Points.

getNumberOfControlPoints

public java.lang.String getNumberOfControlPoints()

Retrieves Number of control points in Channel.

Returns:

String - value of Number of control points in Channel.

getBrachyControlPointDeliveredSequence

public BrachyControlPointDeliveredSequence getBrachyControlPointDeliveredSequence()

Retrieves pre-initialized object of Brachy Control Point Delivered 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:

BrachyControlPointDeliveredSequence - instance of Brachy Control Point Delivered Sequence.

getPulseSpecificBrachyControlPointDeliveredSequence

public PulseSpecificBrachyControlPointDeliveredSequence getPulseSpecificBrachyControlPointDeliveredSequence()

Retrieves pre-initialized object of Pulse Specific Brachy Control Point Delivered 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:

PulseSpecificBrachyControlPointDeliveredSequence - instance of Pulse Specific Brachy Control Point Delivered Sequence.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in RecordedChannelSequenceItem 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.