Package org.dcm4che.typeddicom.dataelements

Class ProtocolElementPurpose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ProtocolElementPurpose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class ProtocolElementPurpose
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Protocol Element Purpose
Keyword: ProtocolElementPurpose
Tag: (0018,9924)
Value Representation: UT
Value Multiplicity: 1

• Described in the contexts:
  • Protocol Element Identification Macro > Protocol Element Purpose
  as follows:
  Attribute Name: Protocol Element Purpose
  Type: 3
  Attribute Description:

  Description of the purpose this element serves in the protocol.

  Note

  1. This is intended for use by the radiologist, technologist and/or physicist during management of the Protocol to understand the purpose the Protocol Element serves in the Protocol.

  2. It is not intended to be copied into the Series Description. Rather there is an Attribute in the Performed Storage Module called Requested Series Description (0018,9937) that is intended to be copied into the Series Description of the stored Instances.

  
  

Nested Class Summary

Nested Classes

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

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 String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnlimitedTextWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ProtocolElementPurpose()	Creates a new Protocol Element Purpose object which wraps a new and empty Attributes object.
ProtocolElementPurpose(org.dcm4che3.data.Attributes attributes)	Creates a new Protocol Element Purpose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ProtocolElementPurpose	copy()	Returns a new Protocol Element Purpose which wraps a copy of the Attributes wrapped in this Protocol Element Purpose.
String	getPrivateCreator()
int	getTag()

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

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnlimitedTextWrapper

getValueRepresentation

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ProtocolElementPurpose

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

Creates a new Protocol Element Purpose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ProtocolElementPurpose

public ProtocolElementPurpose()

Creates a new Protocol Element Purpose object which wraps a new and empty Attributes object.

Method Details

copy

public ProtocolElementPurpose copy()

Returns a new Protocol Element Purpose which wraps a copy of the Attributes wrapped in this Protocol Element Purpose. (see Attributes(Attributes)

Returns:

a new Protocol Element Purpose which wraps a copy of the Attributes wrapped in this Protocol Element Purpose.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.