Package org.dcm4che.typeddicom.dataelements

Class EntityDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.EntityDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class EntityDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Entity Description
Keyword: EntityDescription
Tag: (3010,0037)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • Entity Labeling Macro > Entity Description
  • Entity Long Labeling Macro > Entity Description
  as follows:
  Attribute Name: Entity Description
  Type: 3
  Attribute Description:

  User-defined description for this entity.

  See DICOM Standard Part 3 - Section 10.31.1.2.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

Method Summary

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

EntityDescription

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

Creates a new Entity Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

EntityDescription

public EntityDescription()

Creates a new Entity Description object which wraps a new and empty Attributes object.

Method Details

copy

public EntityDescription copy()

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

Returns:

a new Entity Description which wraps a copy of the Attributes wrapped in this Entity Description.

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.