Package org.dcm4che.typeddicom.dataelements

Class PatientSetupNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientSetupNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class PatientSetupNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Patient Setup Number
Keyword: PatientSetupNumber
Tag: (300A,0182)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Patient Setup Number
  as follows:
  Attribute Name: Patient Setup Number
  Type: 1
  Attribute Description:

  Identification number of the Patient Setup. The value of Patient Setup Number (300A,0182) shall be unique within the RT Plan in which it is created.

  
  
• Described in the contexts:
  • RT General Machine Verification Module > General Machine Verification Sequence > Patient Setup Sequence > Patient Setup Number
  as follows:
  Attribute Name: Patient Setup Number
  Type:
  Attribute Description:

  Identification number of the Patient Setup.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PatientSetupNumber()	Creates a new Patient Setup Number object which wraps a new and empty Attributes object.
PatientSetupNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Patient Setup Number object which wraps the provided attributes.

Method Summary

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

getInt, setInt

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

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

PatientSetupNumber

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

Creates a new Patient Setup Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientSetupNumber

public PatientSetupNumber()

Creates a new Patient Setup Number object which wraps a new and empty Attributes object.

Method Details

copy

public PatientSetupNumber copy()

Returns a new Patient Setup Number which wraps a copy of the Attributes wrapped in this Patient Setup Number. (see Attributes(Attributes)

Returns:

a new Patient Setup Number which wraps a copy of the Attributes wrapped in this Patient Setup Number.

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.