Package org.dcm4che.typeddicom.dataelements

Class SetupImageComment

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SetupImageComment

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class SetupImageComment
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Setup Image Comment
Keyword: SetupImageComment
Tag: (300A,0402)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Referenced Setup Image Sequence > Setup Image Comment
  as follows:
  Attribute Name: Setup Image Comment
  Type: 3
  Attribute Description:

  Comment on the Setup Image.

  
  

Nested Class Summary

Nested Classes

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

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 int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
SetupImageComment()	Creates a new Setup Image Comment object which wraps a new and empty Attributes object.
SetupImageComment(org.dcm4che3.data.Attributes attributes)	Creates a new Setup Image Comment object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SetupImageComment	copy()	Returns a new Setup Image Comment which wraps a copy of the Attributes wrapped in this Setup Image Comment.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

SetupImageComment

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

Creates a new Setup Image Comment object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SetupImageComment

public SetupImageComment()

Creates a new Setup Image Comment object which wraps a new and empty Attributes object.

Method Details

copy

public SetupImageComment copy()

Returns a new Setup Image Comment which wraps a copy of the Attributes wrapped in this Setup Image Comment. (see Attributes(Attributes)

Returns:

a new Setup Image Comment which wraps a copy of the Attributes wrapped in this Setup Image Comment.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.