Package org.dcm4che.typeddicom.dataelements

Class OverrideReason

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OverrideReason

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class OverrideReason
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Override Reason
Keyword: OverrideReason
Tag: (3008,0066)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • RT General Machine Verification Module > Overridden Parameters Sequence > Override Reason
  as follows:
  Attribute Name: Override Reason
  Type:
  Attribute Description:

  User-defined description of reason for override of overridden parameter.

  
  
• Described in the contexts:
  • RT Radiation Record Common Module > Treatment Tolerance Violation Sequence > Override Sequence > Override Reason
  as follows:
  Attribute Name: Override Reason
  Type: 2
  Attribute Description:

  User-defined reason of the override.

  May contain notes, e.g. on the justification why the treatment was delivered in the presence of an interlock or unexpected machine condition.

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Override Sequence > Override Reason
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Override Sequence > Override Reason
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Brachy Control Point Delivered Sequence > Override Sequence > Override Reason
  as follows:
  Attribute Name: Override Reason
  Type: 3
  Attribute Description:

  User-defined description of reason for override of parameter specified by Override Parameter Pointer (3008,0062).

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Pulse Specific Brachy Control Point Delivered Sequence > Brachy Pulse Control Point Delivered Sequence > Override Sequence > Override Reason
  as follows:
  Attribute Name: Override Reason
  Type: 3
  Attribute Description:

  User-defined description of reason for override.

  
  

Nested Class Summary

Nested Classes

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

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

ShortTextWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends ShortTextWrapper>

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OverrideReason()	Creates a new Override Reason object which wraps a new and empty Attributes object.
OverrideReason(org.dcm4che3.data.Attributes attributes)	Creates a new Override Reason object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OverrideReason	copy()	Returns a new Override Reason which wraps a copy of the Attributes wrapped in this Override Reason.
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.ShortTextWrapper

getValueRepresentation

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final 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 Details

OverrideReason

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

Creates a new Override Reason object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OverrideReason

public OverrideReason()

Creates a new Override Reason object which wraps a new and empty Attributes object.

Method Details

copy

public OverrideReason copy()

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

Returns:

a new Override Reason which wraps a copy of the Attributes wrapped in this Override Reason.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.