Package org.dcm4che.typeddicom.dataelements

Class PatientSpeciesDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PatientSpeciesDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class PatientSpeciesDescription
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Patient Species Description
Keyword: PatientSpeciesDescription
Tag: (0010,2201)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Patient Module > Patient Species Description
  as follows:
  Attribute Name: Patient Species Description
  Type: 1C
  Attribute Description:

  The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. See DICOM Standard Part 3 - Section C.7.1.1.1.3.

  Required if the Patient is an animal and if Patient Species Code Sequence (0010,2202) is not present. May be present otherwise.

  
  
• Described in the contexts:
  • Patient Demographic Module > Patient Species Description
  as follows:
  Attribute Name: Patient Species Description
  Type:
  Attribute Description:

  The taxonomic rank value (e.g., genus, subgenus, species or subspecies) of the Patient. See DICOM Standard Part 3 - Section C.7.1.1.1.3.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

PatientSpeciesDescription

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

Creates a new Patient Species Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PatientSpeciesDescription

public PatientSpeciesDescription()

Creates a new Patient Species Description object which wraps a new and empty Attributes object.

Method Details

copy

public PatientSpeciesDescription copy()

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

Returns:

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

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.