Class DicomItem

Namespace

FellowOakDicom

Assembly

fo-dicom.core.dll

Abstract base class for representing one DICOM item.

public abstract class DicomItem : IComparable<DicomItem>, IComparable

Inheritance

object

DicomItem

Implements

IComparable<DicomItem>

IComparable

Derived

DicomElement

DicomFragmentSequence

DicomSequence

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

LinqExtensions.IsOneOf<T>(T, params T[])

Constructors

DicomItem(DicomTag)

Initializes an instance of the DicomItem class.

protected DicomItem(DicomTag tag)

Parameters

tag DicomTag

Tag associated with the item.

Properties

Tag

Gets the DICOM tag associated with the item.

public DicomTag Tag { get; }

Property Value

DicomTag

ValueRepresentation

Gets the Value Representation of the item.

public abstract DicomVR ValueRepresentation { get; }

Property Value

DicomVR

Methods

CompareTo(DicomItem)

Compare this DicomItem with the other. Comparison is purely based on the item's tag.

public int CompareTo(DicomItem other)

Parameters

other DicomItem

DICOM item to compare against.

Returns

int

Value less than zero if this item's tag is less than other's, zero if the items' tags are equal and value greater than zero if this item's tag is greater than other's.

CompareTo(object)

Compare this DicomItem with obj. Comparison will only succeed if obj also is a DicomItem. Otherwise method throws.

public int CompareTo(object obj)

Parameters

obj object

Object to compare against, required to be a DicomItem.

Returns

int

If obj is a DicomItem, value less than zero if this item's tag is less than obj's, zero if the items' tags are equal and value greater than zero if this item's tag is greater than obj's.

ToString()

Returns a string summary of the DICOM item.

public override string ToString()

Returns

string

Validate()

public virtual void Validate()