Package org.dcm4che.typeddicom.dataelements

Class FrameComments

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameComments

All Implemented Interfaces:

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

public class FrameComments
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements LongTextWrapper

Name: Frame Comments
Keyword: FrameComments
Tag: (0020,9158)
Value Representation: LongText
Value Multiplicity: 1

• Described in the contexts:
  • Frame Content Macro > Frame Content Sequence > Frame Comments
  as follows:
  Attribute Name: Frame Comments
  Type: 3
  Attribute Description:

  User-defined comments about the frame.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.LongTextWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FrameComments()	Creates a new Frame Comments object which wraps a new and empty Attributes object.
FrameComments(org.dcm4che3.data.Attributes attributes)	Creates a new Frame Comments object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
FrameComments	copy()	Returns a new Frame Comments which wraps a copy of the Attributes wrapped in this Frame Comments.
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, getKnownAttributeTags, getUnknownAttributeTags, 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.LongTextWrapper

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

FrameComments

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

Creates a new Frame Comments object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

FrameComments

public FrameComments()

Creates a new Frame Comments object which wraps a new and empty Attributes object.

Method Detail

copy

public FrameComments copy()

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

Returns:

a new Frame Comments which wraps a copy of the Attributes wrapped in this Frame Comments.

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