cdac.medinfo.sdk.dcm30_04.baselibs

Class FractionGroupSummarySequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.FractionGroupSummarySequenceItem

All Implemented Interfaces:

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

public class FractionGroupSummarySequenceItem
extends Item

This item class contains methods to validate, set and get the attributes of FractionGroupSummarySequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFractionGroupType() Return indicates type of fraction group.
FractionStatusSummarySequence	getFractionStatusSummarySequence() Retrieves pre-initialized object of Fraction Status Summary 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	getNumberOfFractionsDelivered() Return number of fractions delivered as of Treatment Summary Report.
java.lang.String	getNumberOfFractionsPlanned() Return Number of fractions planned for this fraction group.
java.lang.String	getReferencedFractionGroupNumber() Return Referenced Fraction Group Number which references Fraction Group Number (300A,0071) in Fraction Group Sequence (300A,0070) in the referenced RT Plan.
void	setFractionGroupType(EnumFractionGroupType enumFractionGroupType) Sets indicates type of fraction group.
void	setNumberOfFractionsDelivered(java.lang.String strNumberOfFractionsDelivered) Sets number of fractions delivered as of Treatment Summary Report.
void	setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned) Sets Number of fractions planned for this fraction group.
void	setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber) Sets Referenced Fraction Group Number which references Fraction Group Number (300A,0071) in Fraction Group Sequence (300A,0070) in the referenced RT Plan.
boolean	validateForModule() Validates all the attributes in CodeSequenceMacro 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 CodeSequenceMacro 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.

setReferencedFractionGroupNumber

public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)

Sets Referenced Fraction Group Number which references Fraction Group Number (300A,0071) in Fraction Group Sequence (300A,0070) in the referenced RT Plan.

Parameters:

strReferencedFractionGroupNumber - String value of Referenced Fraction Group Number.

getReferencedFractionGroupNumber

public java.lang.String getReferencedFractionGroupNumber()

Return Referenced Fraction Group Number which references Fraction Group Number (300A,0071) in Fraction Group Sequence (300A,0070) in the referenced RT Plan.

Returns:

String - value of Referenced Fraction Group Number.

setFractionGroupType

public void setFractionGroupType(EnumFractionGroupType enumFractionGroupType)

Sets indicates type of fraction group. Required if Fraction Group Summary Sequence (3008,0220) is sent. Enumerated Values: 1) EXTERNAL_BEAM, 2) BRACHY.

Parameters:

enumFractionGroupType - enum value of Referenced Fraction Group Type.

getFractionGroupType

public java.lang.String getFractionGroupType()

Return indicates type of fraction group. Required if Fraction Group Summary Sequence (3008,0220) is sent.

Returns:

String - value of Referenced Fraction Group Type.

setNumberOfFractionsPlanned

public void setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned)

Sets Number of fractions planned for this fraction group. Required if Fraction Group Summary Sequence (3008,0220) is sent.

Parameters:

strNumberOfFractionsPlanned - Number of fractions planned for this fraction group.

getNumberOfFractionsPlanned

public java.lang.String getNumberOfFractionsPlanned()

Return Number of fractions planned for this fraction group.

Returns:

String - Number of fractions planned.

setNumberOfFractionsDelivered

public void setNumberOfFractionsDelivered(java.lang.String strNumberOfFractionsDelivered)

Sets number of fractions delivered as of Treatment Summary Report.

Parameters:

strNumberOfFractionsDelivered - String value of number of fractions delivered.

getNumberOfFractionsDelivered

public java.lang.String getNumberOfFractionsDelivered()

Return number of fractions delivered as of Treatment Summary Report.

Returns:

String - value of number of fractions delivered.

getFractionStatusSummarySequence

public FractionStatusSummarySequence getFractionStatusSummarySequence()

Retrieves pre-initialized object of Fraction Status Summary 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:

FractionStatusSummarySequence - instance of FractionStatusSummarySequence.