Package org.dcm4che.typeddicom.dataelements

Class OpticalPathIdentifier

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OpticalPathIdentifier

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class OpticalPathIdentifier
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Optical Path Identifier
Keyword: OpticalPathIdentifier
Tag: (0048,0106)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • Optical Path Module > Optical Path Sequence > Optical Path Identifier
  as follows:
  Attribute Name: Optical Path Identifier
  Type: 1
  Attribute Description:

  Identifier for the optical path specified in the Sequence Item. The identifier shall be unique for each Item within the Optical Path Sequence.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
OpticalPathIdentifier()	Creates a new Optical Path Identifier object which wraps a new and empty Attributes object.
OpticalPathIdentifier(org.dcm4che3.data.Attributes attributes)	Creates a new Optical Path Identifier object which wraps the provided attributes.

Method Summary

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

OpticalPathIdentifier

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

Creates a new Optical Path Identifier object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OpticalPathIdentifier

public OpticalPathIdentifier()

Creates a new Optical Path Identifier object which wraps a new and empty Attributes object.

Method Details

copy

public OpticalPathIdentifier copy()

Returns a new Optical Path Identifier which wraps a copy of the Attributes wrapped in this Optical Path Identifier. (see Attributes(Attributes)

Returns:

a new Optical Path Identifier which wraps a copy of the Attributes wrapped in this Optical Path Identifier.

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.