Package org.dcm4che.typeddicom.dataelements

Class ClinicalTrialProtocolName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ClinicalTrialProtocolName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ClinicalTrialProtocolName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Clinical Trial Protocol Name
Keyword: ClinicalTrialProtocolName
Tag: (0012,0021)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Patient Medical Module > Patient Clinical Trial Participation Sequence > Clinical Trial Protocol Name
  as follows:
  Attribute Name: Clinical Trial Protocol Name
  Type:
  Attribute Description:

  The name or title of the clinical trial or research protocol.

  
  
• Described in the contexts:
  • Clinical Trial Subject Module > Clinical Trial Protocol Name
  as follows:
  Attribute Name: Clinical Trial Protocol Name
  Type: 2
  Attribute Description:

  The name of the clinical trial or research protocol. See DICOM Standard Part 3 - Section C.7.1.3.1.3.

  
  
• Described in the contexts:
  • Clinical Trial Context Module > Clinical Trial Protocol Name
  as follows:
  Attribute Name: Clinical Trial Protocol Name
  Type: 2
  Attribute Description:

  The name of the clinical trial protocol .See DICOM Standard Part 3 - Section C.7.1.3.1.3.

  
  

Nested Class Summary

Nested Classes

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

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 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
ClinicalTrialProtocolName()	Creates a new Clinical Trial Protocol Name object which wraps a new and empty Attributes object.
ClinicalTrialProtocolName(org.dcm4che3.data.Attributes attributes)	Creates a new Clinical Trial Protocol Name object which wraps the provided attributes.

Method Summary

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

ClinicalTrialProtocolName

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

Creates a new Clinical Trial Protocol Name object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ClinicalTrialProtocolName

public ClinicalTrialProtocolName()

Creates a new Clinical Trial Protocol Name object which wraps a new and empty Attributes object.

Method Details

copy

public ClinicalTrialProtocolName copy()

Returns a new Clinical Trial Protocol Name which wraps a copy of the Attributes wrapped in this Clinical Trial Protocol Name. (see Attributes(Attributes)

Returns:

a new Clinical Trial Protocol Name which wraps a copy of the Attributes wrapped in this Clinical Trial Protocol Name.

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.