Package org.dcm4che.typeddicom.dataelements

Class RTImageName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTImageName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class RTImageName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: RT Image Name
Keyword: RTImageName
Tag: (3002,0003)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • RT Image Module > RT Image Name
  as follows:
  Attribute Name: RT Image Name
  Type: 3
  Attribute Description:

  User-defined name for RT Image.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
RTImageName()	Creates a new RT Image Name object which wraps a new and empty Attributes object.
RTImageName(org.dcm4che3.data.Attributes attributes)	Creates a new RT Image Name object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTImageName	copy()	Returns a new RT Image Name which wraps a copy of the Attributes wrapped in this RT Image Name.
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

RTImageName

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

Creates a new RT Image Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTImageName

public RTImageName()

Creates a new RT Image Name object which wraps a new and empty Attributes object.

Method Details

copy

public RTImageName copy()

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

Returns:

a new RT Image Name which wraps a copy of the Attributes wrapped in this RT Image Name.

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.