Delete Method

Summary

Deletes the specified item from the IOD Structure.

Syntax

C++

Java

public DicomIod Delete( 
   DicomIod iod 
)

Public Function Delete( _ 
   ByVal iod As DicomIod _ 
) As DicomIod

public DicomIod delete(DicomIod iod)

public: 
DicomIod^ Delete(  
   DicomIod^ iod 
)

Parameters

iod
The item to be deleted.

Return Value

A DicomIod class that contains adjacent item. If the item being deleted has a sibling (same level, same parent), following it, the returned class will be this sibling. If the item being deleted does not have a sibling following it, but has a sibling preceding it, the returned pointer class will be the preceding sibling. If the item being deleted is an only child, the returned class will be the parent.

Remarks

You can remove all items from the IOD Structure using Reset.
Since the IOD Structure is stored internally as a tree, the deletion must be carried out as a tree.
Since the IOD Structure is stored internally as a tree, the deletion must be carried out as a tree.
Below are illustrations of these situations: For the sake of these illustrations, the order of siblings is top to bottom. A preceding sibling is drawn above the sibling it precedes, a following sibling is drawn below the sibling it follows. Please note that the numbering of the items of interest is arbitrary, and does not imply order. In this illustration item 2 will be deleted. Since it has a following sibling, the returned class will be item 3.

In this illustration item 3 will be deleted. Since it does not have a following sibling, but does have a preceding sibling, the returned class will be item 2.

In this illustration item 2 will be deleted. Since it is an only child, the returned class will be the parent, item 1.

In this illustration item 1 will be deleted. Since it has no siblings and no parent, this method will return null.