Package org.dcm4che.typeddicom.dataelements

Class ProtocolName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ProtocolName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ProtocolName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Protocol Name
Keyword: ProtocolName
Tag: (0018,1030)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Key Object Document Series Module > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 3
  Attribute Description:

  Description of the conditions under which the Series was performed.

  Note

  This may represent the type of analysis used in creation of the KO SOP Instances.

  
  
• Described in the contexts:
  • General Contributing Sources Macro > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 1C
  Attribute Description:

  User-defined description of the conditions under which the Series was performed.

  Required if present and consistent in the contributing SOP Instances.

  Note

  This Attribute conveys Series-specific protocol identification and may or may not be identical to the one presented in the Performed Protocol Code Sequence (0040,0260).

  
  
• Described in the contexts:
  • Protocol Context Module > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 1
  Attribute Description:

  Name for this Protocol.

  
  
• Described in the contexts:
  • General Series Module > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 3
  Attribute Description:

  User-defined description of the conditions under which the Series was performed.

  Note

  This Attribute conveys Series-specific protocol identification and may or may not be identical to the protocol described in the Performed Protocol Code Sequence (0040,0260) in the Performed Protocol Code Sequence (0040,0260) in DICOM Standard Part 3 - Table 10-16.

  
  
• Described in the contexts:
  • Image Acquisition Results Module > Performed Series Sequence > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type:
  Attribute Description:

  User-defined description of the conditions under which the Series was performed.

  Note

  This Attribute conveys Series-specific protocol identification and may or may not be identical to the one presented in the Performed Protocol Code Sequence (0040,0260).

  
  
• Described in the contexts:
  • SR Document Series Module > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 3
  Attribute Description:

  Description of the conditions under which the Series was performed.

  Note

  This may represent the type of analysis used in creation of the SR SOP Instances.

  
  
• Described in the contexts:
  • Encapsulated Document Series Module > Protocol Name
  as follows:
  Attribute Name: Protocol Name
  Type: 3
  Attribute Description:

  Description of the conditions under which the Series was performed.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

Method Summary

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

ProtocolName

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

Creates a new Protocol Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ProtocolName

public ProtocolName()

Creates a new Protocol Name object which wraps a new and empty Attributes object.

Method Details

copy

public ProtocolName copy()

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

Returns:

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

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.