Package org.dcm4che.typeddicom.dataelements

Class ProtocolDefinedPatientPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ProtocolDefinedPatientPosition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ProtocolDefinedPatientPosition
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Protocol Defined Patient Position
Keyword: ProtocolDefinedPatientPosition
Tag: (0018,9947)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Patient Positioning Module > Protocol Defined Patient Position
  as follows:
  Attribute Name: Protocol Defined Patient Position
  Type: 1
  Attribute Description:

  Patient position relative to the equipment described by the procedure protocol.

  See DICOM Standard Part 3 - Section C.7.3.1.1.2 for Defined Terms and further explanation.

  
  

Nested Class Summary

Nested Classes

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

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
ProtocolDefinedPatientPosition()	Creates a new Protocol Defined Patient Position object which wraps a new and empty Attributes object.
ProtocolDefinedPatientPosition(org.dcm4che3.data.Attributes attributes)	Creates a new Protocol Defined Patient Position object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ProtocolDefinedPatientPosition	copy()	Returns a new Protocol Defined Patient Position which wraps a copy of the Attributes wrapped in this Protocol Defined Patient Position.
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

ProtocolDefinedPatientPosition

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

Creates a new Protocol Defined Patient Position object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ProtocolDefinedPatientPosition

public ProtocolDefinedPatientPosition()

Creates a new Protocol Defined Patient Position object which wraps a new and empty Attributes object.

Method Details

copy

public ProtocolDefinedPatientPosition copy()

Returns a new Protocol Defined Patient Position which wraps a copy of the Attributes wrapped in this Protocol Defined Patient Position. (see Attributes(Attributes)

Returns:

a new Protocol Defined Patient Position which wraps a copy of the Attributes wrapped in this Protocol Defined Patient Position.

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.