cdac.medinfo.sdk.dcm30_04.baselibs

Class FractionGroupSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.FractionGroupSequenceItem

All Implemented Interfaces:

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

public class FractionGroupSequenceItem
extends Item

This Item class provides methods to set,get and validate attributes in FractionGroupSequenceItem

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBeamDoseMeaning() Return Beam Dose Meaning.
java.lang.String	getFractionGroupDescription() Return user defined description for the fraction group.
java.lang.String	getFractionGroupNumber() Return identification number of the Fraction Group.
java.lang.String	getFractionPattern() Return string of 0's (no treatment) and 1's (treatment) describing treatment pattern.
java.lang.String	getNumberOfBeams() Return number of beams in current Fraction Group.
java.lang.String	getNumberOfBrachyApplicationSetups() Return number of Brachy Application Setups in current Fraction Group.
java.lang.String	getNumberOfFractionPatternDigitsPerDay() Return number of digits in Fraction Pattern (300A,007B) used to represent one day.
java.lang.String	getNumberOfFractionsPlanned() Return Total number of treatments (Fractions)prescribed for current Fraction Group.
ReferencedBeamSequence	getReferencedBeamSequence() Retrieves pre-initialized object of Referenced Beam 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.
ReferencedBrachyApplicationSetupSequence	getReferencedBrachyApplicationSetupSequence() Retrieves pre-initialized object of Referenced Brachy Application Setup 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.
ReferencedDoseReferenceSequence	getReferencedDoseReferenceSequence() Retrieves pre-initialized object of Referenced 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.
ReferencedDoseSequence	getReferencedDoseSequence() Retrieves pre-initialized object of Referenced Dose 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	getRepeatFractionCycleLength() Return number of weeks needed to describe treatment pattern.
void	setBeamDoseMeaning(EnumBeamDoseMeaning enumBeamDoseMeaning) Sets Beam Dose Meaning.
void	setFractionGroupDescription(java.lang.String strFractionGroupDescription) Sets user defined description for the fraction group.
void	setFractionGroupNumber(java.lang.String strFractionGroupNumber) Sets identification number of the Fraction Group.
void	setFractionPattern(java.lang.String strFractionPattern) Sets string of 0's (no treatment) and 1's (treatment) describing treatment pattern.
void	setNumberOfBeams(java.lang.String strNumberOfBeams) Sets number of beams in current Fraction Group.
void	setNumberOfBrachyApplicationSetups(java.lang.String strNumberOfBrachyApplicationSetups) Sets number of Brachy Application Setups in current Fraction Group.
void	setNumberOfFractionPatternDigitsPerDay(java.lang.String strNumberOfFractionsPlanned) Sets number of digits in Fraction Pattern (300A,007B) used to represent one day.
void	setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned) Sets Total number of treatments (Fractions)prescribed for current Fraction Group.
void	setRepeatFractionCycleLength(java.lang.String strNumberOfFractionsPlanned) Sets number of weeks needed to describe treatment pattern.
boolean	validateForModule() Validates all the attributes in FractionGroupSequenceItem 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 FractionGroupSequenceItem 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.

setFractionGroupNumber

public void setFractionGroupNumber(java.lang.String strFractionGroupNumber)

Sets identification number of the Fraction Group.

Parameters:

strFractionGroupNumber - String value of Fraction Number.

getFractionGroupNumber

public java.lang.String getFractionGroupNumber()

Return identification number of the Fraction Group.

Returns:

String - value of Fraction Group Number.

setFractionGroupDescription

public void setFractionGroupDescription(java.lang.String strFractionGroupDescription)

Sets user defined description for the fraction group.

Parameters:

strFractionGroupDescription - String value of Fraction Description.

getFractionGroupDescription

public java.lang.String getFractionGroupDescription()

Return user defined description for the fraction group.

Returns:

String - value of Fraction Description.

getReferencedDoseSequence

public ReferencedDoseSequence getReferencedDoseSequence()

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

ReferencedDoseSequence - instance of ReferencedDoseSequence.

getReferencedDoseReferenceSequence

public ReferencedDoseReferenceSequence getReferencedDoseReferenceSequence()

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

ReferencedDoseReferenceSequence - instance of ReferencedDoseReferenceSequence.

setNumberOfFractionsPlanned

public void setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned)

Sets Total number of treatments (Fractions)prescribed for current Fraction Group.

Parameters:

strNumberOfFractionsPlanned - String value of Total number of treatments.

getNumberOfFractionsPlanned

public java.lang.String getNumberOfFractionsPlanned()

Return Total number of treatments (Fractions)prescribed for current Fraction Group.

Returns:

String - value of Total number of treatments.

setNumberOfFractionPatternDigitsPerDay

public void setNumberOfFractionPatternDigitsPerDay(java.lang.String strNumberOfFractionsPlanned)

Sets number of digits in Fraction Pattern (300A,007B) used to represent one day.

Parameters:

strNumberOfFractionsPlanned - String value of Number of Fraction Pattern Digits Per Day.

getNumberOfFractionPatternDigitsPerDay

public java.lang.String getNumberOfFractionPatternDigitsPerDay()

Return number of digits in Fraction Pattern (300A,007B) used to represent one day.

Returns:

String - value of Number of Fraction Pattern Digits Per Day.

setRepeatFractionCycleLength

public void setRepeatFractionCycleLength(java.lang.String strNumberOfFractionsPlanned)

Sets number of weeks needed to describe treatment pattern.

Parameters:

strNumberOfFractionsPlanned - String value of Repeat Fraction Cycle Length.

getRepeatFractionCycleLength

public java.lang.String getRepeatFractionCycleLength()

Return number of weeks needed to describe treatment pattern.

Returns:

String - value of Repeat Fraction Cycle Length.

setFractionPattern

public void setFractionPattern(java.lang.String strFractionPattern)

Sets string of 0's (no treatment) and 1's (treatment) describing treatment pattern. Length of string is 7 x Number of Fraction Pattern Digits Per Day x Repeat Fraction Cycle Length. Pattern shall start on a Monday.

Parameters:

strFractionPattern - String value of Fraction Pattern.

getFractionPattern

public java.lang.String getFractionPattern()

Return string of 0's (no treatment) and 1's (treatment) describing treatment pattern. Length of string is 7 x Number of Fraction Pattern Digits Per Day x Repeat Fraction Cycle Length. Pattern shall start on a Monday.

Returns:

String - value of Fraction Pattern.

setBeamDoseMeaning

public void setBeamDoseMeaning(EnumBeamDoseMeaning enumBeamDoseMeaning)

Sets Beam Dose Meaning. Defined Terms: 1) BEAM_LEVEL. 2) FRACTION_LEVEL.

Parameters:

enumBeamDoseMeaning - enum value of Beam Dose Meaning.

getBeamDoseMeaning

public java.lang.String getBeamDoseMeaning()

Return Beam Dose Meaning.

Returns:

String - value of Beam Dose Meaning.

setNumberOfBeams

public void setNumberOfBeams(java.lang.String strNumberOfBeams)

Sets number of beams in current Fraction Group. If Number of Beams is greater then zero, Number of Brachy Application Setups (300A,00A0) shall equal zero.

Parameters:

strNumberOfBeams - String value of Number of Beams.

getNumberOfBeams

public java.lang.String getNumberOfBeams()

Return number of beams in current Fraction Group. If Number of Beams is greater then zero, Number of Brachy Application Setups (300A,00A0) shall equal zero.

Returns:

String - value of Number of Beams.

getReferencedBeamSequence

public ReferencedBeamSequence getReferencedBeamSequence()

Retrieves pre-initialized object of Referenced Beam 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:

ReferencedBeamSequence - instance of ReferencedBeamSequence.

setNumberOfBrachyApplicationSetups

public void setNumberOfBrachyApplicationSetups(java.lang.String strNumberOfBrachyApplicationSetups)

Sets number of Brachy Application Setups in current Fraction Group. If Number of Brachy Application Setups is greater then zero, Number of Beams (300A,0080) shall equal zero.

Parameters:

strNumberOfBrachyApplicationSetups - String value of Number of Brachy Application Setups.

getNumberOfBrachyApplicationSetups

public java.lang.String getNumberOfBrachyApplicationSetups()

Return number of Brachy Application Setups in current Fraction Group. If Number of Brachy Application Setups is greater then zero, Number of Beams (300A,0080) shall equal zero.

Returns:

String - value of Number of Brachy Application Setups.

getReferencedBrachyApplicationSetupSequence

public ReferencedBrachyApplicationSetupSequence getReferencedBrachyApplicationSetupSequence()

Retrieves pre-initialized object of Referenced Brachy Application Setup 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:

ReferencedBrachyApplicationSetupSequence - instance of ReferencedBrachyApplicationSetupSequence.