Package org.dcm4che.typeddicom.dataelements

Class DataPathID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DataPathID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DataPathID
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Data Path ID
Keyword: DataPathID
Tag: (0028,140E)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Enhanced Palette Color Lookup Table Module > Enhanced Palette Color Lookup Table Sequence > Data Path ID
  as follows:
  Attribute Name: Data Path ID
  Type: 1
  Attribute Description:

  Identifier of the data path in which this Palette Color Lookup Table is used.

  Enumerated Values:

  PRIMARY

  SECONDARY

  Each Item shall have a distinct value of Data Path ID.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

Method Summary

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

DataPathID

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

Creates a new Data Path ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DataPathID

public DataPathID()

Creates a new Data Path ID object which wraps a new and empty Attributes object.

Method Details

copy

public DataPathID copy()

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

Returns:

a new Data Path ID which wraps a copy of the Attributes wrapped in this Data Path ID.

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.