cdac.medinfo.sdk.dcm30_04.baselibs

Class PlanningLandmarkPlaneSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.PlanningLandmarkPlaneMacroDependentItem

cdac.medinfo.sdk.dcm30_04.baselibs.PlanningLandmarkPlaneSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class PlanningLandmarkPlaneSequenceItem
extends PlanningLandmarkPlaneMacroDependentItem

This item class contains the methods to set, get and validate the attribute present in Planning Landmark Plane Sequence .

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getPlanningLandmarkDescription() Return Planning Landmark Description.
short	getPlanningLandmarkID() Retrieves Planning Landmark ID.
PlanningLandmarkIdentificationCodeSequence	getPlanningLandmarkIdentificationCodeSequence() Retrieves pre-initialized object of Planning Landmark Identification Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
void	setPlanningLandmarkDescription(java.lang.String strPlanningLandmarkDescription) Sets Planning Landmark Description.
void	setPlanningLandmarkID(short shPlanningLandmarkID) Sets Planning Landmark ID.
boolean	validateForModule() Validates all the attributes in PlanningLandmarkPlaneSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.PlanningLandmarkPlaneMacroDependentItem

getPlanningLandmarkPlaneMacro

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in PlanningLandmarkPlaneSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class PlanningLandmarkPlaneMacroDependentItem

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

setPlanningLandmarkID

public void setPlanningLandmarkID(short shPlanningLandmarkID)

Sets Planning Landmark ID. Numeric ID of the planning landmark.

Parameters:

shPlanningLandmarkID - short value of Planning Landmark ID

getPlanningLandmarkID

public short getPlanningLandmarkID()

Retrieves Planning Landmark ID. Numeric ID of the planning landmark.

Returns:

short - short value of Planning Landmark ID

setPlanningLandmarkDescription

public void setPlanningLandmarkDescription(java.lang.String strPlanningLandmarkDescription)

Sets Planning Landmark Description. Purpose or intended use of the landmark.

Parameters:

strPlanningLandmarkDescription - String value of Planning Landmark Description.

getPlanningLandmarkDescription

public java.lang.String getPlanningLandmarkDescription()

Return Planning Landmark Description. Purpose or intended use of the landmark.

Returns:

String - value of Planning Landmark Description.

getPlanningLandmarkIdentificationCodeSequence

public PlanningLandmarkIdentificationCodeSequence getPlanningLandmarkIdentificationCodeSequence()

Retrieves pre-initialized object of Planning Landmark Identification Code Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

PlanningLandmarkIdentificationCodeSequence - instance of PlanningLandmarkIdentificationCodeSequence.