Insert(DicomIod,bool,DicomClassType,string,DicomIodType,DicomIodUsageType,string) Method

Summary

Inserts a new item in the IOD Structure.

Syntax

C++

Java

public DicomIod Insert( 
   DicomIod neighbor, 
   bool child, 
   DicomClassType code, 
   string name, 
   DicomIodType type, 
   DicomIodUsageType usage, 
   string description 
)

Public Overloads Function Insert( _ 
   ByVal neighbor As DicomIod, _ 
   ByVal child As Boolean, _ 
   ByVal code As DicomClassType, _ 
   ByVal name As String, _ 
   ByVal type As DicomIodType, _ 
   ByVal usage As DicomIodUsageType, _ 
   ByVal description As String _ 
) As DicomIod

public DicomIod insert(DicomIod neighbor, boolean child, DicomClassType code, String name, DicomIodType type, DicomIodUsageType usage, String description)

public: 
DicomIod^ Insert(  
   DicomIod^ neighbor, 
   bool child, 
   DicomClassType code, 
   String^ name, 
   DicomIodType type, 
   DicomIodUsageType usage, 
   String^ description 
)

Parameters

neighbor
contains an item in the IOD Structure. The inserted item will be inserted as a neighbor to this item, or as a child, depending on the value of child.

child
true to insert the new item as the last child of neighbor, false to insert the new item as the last sibling of neighbor.

code
The class Information Object Definitions.

name
The name of the inserted item

type
The type of Information Object Definition you are working with.

usage
Indicates whether the Information Object is mandatory, conditional or optional, and the type of usage. For more information on mandatory, conditional and optional usage, refer to An Overview of the DICOM File Format or the DICOM Standard.

description
The description of the inserted class Information Object Definition.

Return Value

DicomIod class containing the newly inserted item.

Remarks

The illustrations below show how items are added to the IOD Structure (internally maintained as a tree), based on the value of child.
For the sake of these illustrations, the order of siblings is top to bottom. Therefore, since added items become the last sibling or the last child, these are drawn at the bottom of the appropriate group of items.
In this illustration, neighbor points to Item 1 and child is false. The new item is added as the last sibling of Item 1

In this illustration, neighbor points to Item 1 and child is true. The new item is added as the last child of Item 1.