Package org.dcm4che.typeddicom.dataelements

Class FractionPattern

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FractionPattern

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, LongTextWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class FractionPattern
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements LongTextWrapper

Name: Fraction Pattern
Keyword: FractionPattern
Tag: (300A,007B)
Value Representation: LongText
Value Multiplicity: 1

• Described in the contexts:
  • Radiation Fraction Pattern Macro > Fraction Pattern Sequence > Weekday Fraction Pattern Sequence > Fraction Pattern
  as follows:
  Attribute Name: Fraction Pattern
  Type: 3
  Attribute Description:

  String of 0's (no treatment) and 1's (treatment) describing the fraction pattern for the fractions defined by this set. Length of string is 7 x Number of Fraction Pattern Digits Per Day x Repeat Fraction Cycle Length. The first character of the string represents Monday.

  See DICOM Standard Part 3 - Section C.36.2.1.1.1.1.

  
  
• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Fraction Pattern
  as follows:
  Attribute Name: Fraction Pattern
  Type: 3
  Attribute Description:

  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. See Note 2.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FractionPattern.Builder<SELF extends FractionPattern.Builder<SELF,T>,T extends FractionPattern.Holder>
static interface	FractionPattern.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Fraction Pattern" (see FractionPattern)
static class	FractionPattern.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongTextWrapper

LongTextWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends LongTextWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongTextWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FractionPattern()	Creates a new Fraction Pattern object which wraps a new and empty Attributes object.
FractionPattern(org.dcm4che3.data.Attributes attributes)	Creates a new Fraction Pattern object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
FractionPattern	copy()	Returns a new Fraction Pattern which wraps a copy of the Attributes wrapped in this Fraction Pattern.
java.lang.String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongTextWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

Constant Field Values

Constructor Detail

FractionPattern

public FractionPattern(org.dcm4che3.data.Attributes attributes)

Creates a new Fraction Pattern object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

FractionPattern

public FractionPattern()

Creates a new Fraction Pattern object which wraps a new and empty Attributes object.

Method Detail

copy

public FractionPattern copy()

Returns a new Fraction Pattern which wraps a copy of the Attributes wrapped in this Fraction Pattern. (see Attributes(Attributes)

Returns:

a new Fraction Pattern which wraps a copy of the Attributes wrapped in this Fraction Pattern.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper