Package org.dcm4che.typeddicom.dataelements

Class HangingProtocolName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.HangingProtocolName

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class HangingProtocolName
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

Name: Hanging Protocol Name
Keyword: HangingProtocolName
Tag: (0072,0002)
Value Representation: ShortString
Value Multiplicity: 1

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

  Short descriptor that identifies the Hanging Protocol.

  
  
• Described in the contexts:
  • Structured Display Module > Hanging Protocol Name
  as follows:
  Attribute Name: Hanging Protocol Name
  Type: 3
  Attribute Description:

  Identifies the hanging protocol that was used in the creation of this structured display.

  See PS3.17 tableOO.1.1-1 for standard hanging protocols for dentistry.

  
  

Nested Class Summary

Nested Classes

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

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

ShortStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends ShortStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
HangingProtocolName()	Creates a new Hanging Protocol Name object which wraps a new and empty Attributes object.
HangingProtocolName(org.dcm4che3.data.Attributes attributes)	Creates a new Hanging Protocol Name object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

HangingProtocolName

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

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

Parameters:

attributes - the Attributes object to be wrapped.

HangingProtocolName

public HangingProtocolName()

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

Method Detail

copy

public HangingProtocolName copy()

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

Returns:

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

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper