Package org.dcm4che.typeddicom.dataelements

Class PlanningLandmarkID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PlanningLandmarkID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class PlanningLandmarkID
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Planning Landmark ID
Keyword: PlanningLandmarkID
Tag: (0068,6530)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Generic Implant Template Planning Landmarks Module > Planning Landmark Point Sequence > Planning Landmark ID
  as follows:
  Attribute Name: Planning Landmark ID
  Type: 1
  Attribute Description:

  Numeric ID of the planning landmark. Uniquely identifies a planning landmark within the SOP Instance.

  The value shall start at 1, and increase monotonically by 1 for each Item.

  
  
• Described in the contexts:
  • Generic Implant Template Planning Landmarks Module > Planning Landmark Line Sequence > Planning Landmark ID
  as follows:
  Attribute Name: Planning Landmark ID
  Type: 1
  Attribute Description:

  Numeric ID of the planning landmark. Uniquely identifies the planning landmark within the SOP Instance. The value shall start at 1, and increase monotonically by 1 for each Item.

  
  
• Described in the contexts:
  • Generic Implant Template Planning Landmarks Module > Planning Landmark Plane Sequence > Planning Landmark ID
  as follows:
  Attribute Name: Planning Landmark ID
  Type: 1
  Attribute Description:

  Numeric ID of the planning landmark. Uniquely identifies the planning landmark within the SOP Instance.

  The value shall start at 1, and increase monotonically by 1 for each Item.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
PlanningLandmarkID()	Creates a new Planning Landmark ID object which wraps a new and empty Attributes object.
PlanningLandmarkID(org.dcm4che3.data.Attributes attributes)	Creates a new Planning Landmark ID object which wraps the provided attributes.

Method Summary

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

getInt, setInt

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

getValueRepresentation

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

PlanningLandmarkID

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

Creates a new Planning Landmark ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PlanningLandmarkID

public PlanningLandmarkID()

Creates a new Planning Landmark ID object which wraps a new and empty Attributes object.

Method Details

copy

public PlanningLandmarkID copy()

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

Returns:

a new Planning Landmark ID which wraps a copy of the Attributes wrapped in this Planning Landmark 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.