Package org.dcm4che.typeddicom.dataelements

Class ReferenceLocationDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferenceLocationDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class ReferenceLocationDescription
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Reference Location Description
Keyword: ReferenceLocationDescription
Tag: (0018,9901)
Value Representation: UT
Value Multiplicity: 1

• Described in the contexts:
  • Reference Location Macro > Reference Location Description
  as follows:
  Attribute Name: Reference Location Description
  Type: 3
  Attribute Description:

  Further elaboration of the Reference Location.

  The value may include a description of the relative anatomical location, the appearance of the feature or landmark, or how it can be identified.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
ReferenceLocationDescription()	Creates a new Reference Location Description object which wraps a new and empty Attributes object.
ReferenceLocationDescription(org.dcm4che3.data.Attributes attributes)	Creates a new Reference Location Description object which wraps the provided attributes.

Method Summary

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

ReferenceLocationDescription

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

Creates a new Reference Location Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferenceLocationDescription

public ReferenceLocationDescription()

Creates a new Reference Location Description object which wraps a new and empty Attributes object.

Method Details

copy

public ReferenceLocationDescription copy()

Returns a new Reference Location Description which wraps a copy of the Attributes wrapped in this Reference Location Description. (see Attributes(Attributes)

Returns:

a new Reference Location Description which wraps a copy of the Attributes wrapped in this Reference Location Description.

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.