Package org.dcm4che.typeddicom.dataelements

Class OffsetDirection

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OffsetDirection

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class OffsetDirection
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Offset Direction
Keyword: OffsetDirection
Tag: (0018,9905)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Reference Location Macro > Offset Direction
  as follows:
  Attribute Name: Offset Direction
  Type: 1C
  Attribute Description:

  Direction of the offset (in terms of patient position) from the Reference Basis to the Reference Location.

  Enumerated Values:

  SUPERIOR

  INFERIOR

  ANTERIOR

  POSTERIOR

  LEFT

  RIGHT

  PROXIMAL

  DISTAL

  MEDIAL

  LATERAL

  Required if Offset Distance (0018,9904) is present.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
OffsetDirection()	Creates a new Offset Direction object which wraps a new and empty Attributes object.
OffsetDirection(org.dcm4che3.data.Attributes attributes)	Creates a new Offset Direction object which wraps the provided attributes.

Method Summary

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

OffsetDirection

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

Creates a new Offset Direction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OffsetDirection

public OffsetDirection()

Creates a new Offset Direction object which wraps a new and empty Attributes object.

Method Details

copy

public OffsetDirection copy()

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

Returns:

a new Offset Direction which wraps a copy of the Attributes wrapped in this Offset Direction.

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.