Delete Method

Summary

Deletes the specified item from the IOD Structure.

Syntax

Objective-C

C++/CLI

Java

public DicomIod Delete( 
   DicomIod iod 
)

- (nullable LTDicomIod *)removeIod:(LTDicomIod *)iod;

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.

Example

using Leadtools; 
using Leadtools.Dicom; 
 
 
public void RecursiveReadIOD(DicomIod parentIOD) 
{ 
   DicomIod iod; 
   if (parentIOD == null) 
   { 
      iod = DicomIodTable.Instance.GetFirst(null, true); 
   } 
   else 
   { 
      iod = DicomIodTable.Instance.GetChild(parentIOD); 
   } 
 
   while (iod != null) 
   { 
      // Over here we can show the information about this IOD such as  
      // DicomIod.Type, DicomIod.Type, DicomIod.Usage and DicomIod.Description 
      if (DicomIodTable.Instance.GetChild(iod) != null) 
      { 
         RecursiveReadIOD(iod); 
      } 
      iod = DicomIodTable.Instance.GetNext(iod, true); 
   } 
} 
void TestIODTable() 
{ 
   //Make sure to initialize the DICOM engine, this needs to be done only once. 
   DicomEngine.Startup(); 
 
   //We don't need to call this since the DicomEngine.Startup already does that for us 
   //These calls are for demonstration purposes only 
   DicomIodTable.Instance.Reset(); 
   DicomIodTable.Instance.Default(); 
 
   // We can find the number of modules in any class 
   int moduleCount = DicomIodTable.Instance.GetModuleCount(DicomClassType.SCImageStorage); 
 
   // We can in here call any of the Find methods including FindModule and FindModuleByIndex, 
   // in this sample we are searching for a DICOM class, this is why we are using FindClass 
   DicomIod iod = DicomIodTable.Instance.FindClass(DicomClassType.SCImageStorage); 
 
   // We can get the name of the IOD 
   string name = iod.ToString(); 
 
   DicomIodTable.Instance.Delete(iod); 
 
   DicomIod iod1 = DicomIodTable.Instance.Insert(null, false, DicomClassType.SCImageStorage, "Secondary Capture Image Storage", DicomIodType.Class, DicomIodUsageType.MandatoryModule, "Description of the class goes in here"); 
   Debug.Assert(DicomIodTable.Instance.Exists(iod1) == true); 
   DicomIodTable.Instance.SetName(iod1, "Secondary Capture Image Storage 1"); 
 
   //Go through all the IODs in the IOD table 
   RecursiveReadIOD(null); 
 
   DicomEngine.Shutdown(); 
}