Package org.dcm4che.typeddicom.dataelements

Class SnoutID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SnoutID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class SnoutID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Snout ID
Keyword: SnoutID
Tag: (300A,030F)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Snout Sequence > Snout ID
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Snout Sequence > Snout ID
  as follows:
  Attribute Name: Snout ID
  Type: 1
  Attribute Description:

  User or machine supplied identifier for Snout.

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Snout Sequence > Snout ID
  as follows:
  Attribute Name: Snout ID
  Type:
  Attribute Description:

  User or machine supplied identifier for Snout.

  
  

Nested Class Summary

Nested Classes

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

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 String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final 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
SnoutID()	Creates a new Snout ID object which wraps a new and empty Attributes object.
SnoutID(org.dcm4che3.data.Attributes attributes)	Creates a new Snout ID object which wraps the provided attributes.

Method Summary

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

PRIVATE_CREATOR

public static final 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 Details

SnoutID

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

Creates a new Snout ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SnoutID

public SnoutID()

Creates a new Snout ID object which wraps a new and empty Attributes object.

Method Details

copy

public SnoutID copy()

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

Returns:

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

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.