Insert Method

Summary

Inserts a new item in the Data Element Tag Table.

Syntax

C++

Java

public DicomTag Insert( 
   long code, 
   long mask, 
   string name, 
   DicomVRType vr, 
   long minVM, 
   long maxVM, 
   long vmDivider 
)

Public Function Insert( _ 
   ByVal code As Long, _ 
   ByVal mask As Long, _ 
   ByVal name As String, _ 
   ByVal vr As DicomVRType, _ 
   ByVal minVM As Long, _ 
   ByVal maxVM As Long, _ 
   ByVal vmDivider As Long _ 
) As DicomTag

public DicomTag insert(long code, long mask, String name, DicomVrType vr, long minVM, long maxVM, long vmDivider)

public: 
DicomTag^ Insert(  
   int64 code, 
   int64 mask, 
   String^ name, 
   DicomVRType vr, 
   int64 minVM, 
   int64 maxVM, 
   int64 vmDivider 
)

Parameters

code
Code that indicates the tag. For a list of default values, refer to Data Element Tag Values.

mask
Masking value. Masking allows you to insert multiple elements in the same entry in the table.

name
The name of the tag. For a list of default values, refer to the Data Element Tag Table.

vr
Value representation code that indicates the type of value stored in the data element.

minVM
The minimum number of values that may be stored in the Value Field of the Data Element.

maxVM
The maximum number of values that may be stored in the Value Field of the Data Element.

vmDivider
Value used to divide the value multiplicity. When multiple values are stored in the value field of a data element, the number of values present must be evenly divisible by vmDivider. For most items vmDivider will be 1. However, if the values stored in the value field are RGB triplets, for example, you would have to store three values for each triplet. You could store 12 values, since 12 values would be 4 triplets, however, you could not store 13 values. In this case vmDivider would be 3.

Return Value

The newly inserted item.

Remarks

All items are inserted at the bottom of the table.
To see the default values for the Data Element Tag Table, refer to the Data Element Tag Table.
For more information on the DICOM file format, refer to An Overview of the DICOM File Format or the DICOM Standard.

Example

For an example, refer to Reset.

Requirements

Target Platforms