Package org.dcm4che.typeddicom.dataelements

Class ProtocolElementNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ProtocolElementNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ProtocolElementNumber
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Protocol Element Number
Keyword: ProtocolElementNumber
Tag: (0018,9921)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • General Defined Acquisition Module > Acquisition Protocol Element Specification Sequence > Protocol Element Number
  as follows:
  Attribute Name: Protocol Element Number
  Type: 1
  Attribute Description:

  The Protocol Element Number of the Acquisition Protocol Element being specified in this Item.

  
  
• Described in the contexts:
  • General Defined Reconstruction Module > Reconstruction Protocol Element Specification Sequence > Protocol Element Number
  as follows:
  Attribute Name: Protocol Element Number
  Type: 1
  Attribute Description:

  The Protocol Element Number of the Reconstruction Protocol Element being specified in this Item.

  
  
• Described in the contexts:
  • Defined Storage Module > Storage Protocol Element Specification Sequence > Protocol Element Number
  as follows:
  Attribute Name: Protocol Element Number
  Type: 1
  Attribute Description:

  The Protocol Element Number of the Storage Protocol Element being specified in this Item.

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

  Identifies the protocol element and the order in which the elements are performed in the Protocol.

  The value shall start at 1 and increase monotonically by 1.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ProtocolElementNumber	copy()	Returns a new Protocol Element Number which wraps a copy of the Attributes wrapped in this Protocol Element Number.
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, getPrivateCreator, getValue

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ProtocolElementNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ProtocolElementNumber

public ProtocolElementNumber()

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

Method Details

copy

public ProtocolElementNumber copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.