Class ValueRepresentation

Class ValueRepresentation

Namespace: Aspose.Medical.Dicom.ValueRepresentations
Assembly: Aspose.Medical.dll (25.11.0)

Encapsulates DICOM VR (value representation). https://dicom.nema.org/medical/dicom/current/output/chtml/part05/sect_6.2.html

public sealed class ValueRepresentation : IEquatable<valuerepresentation>, IStructuralEquatable

Inheritance

object ValueRepresentation

Implements

IEquatable<valuerepresentation> , IStructuralEquatable

Inherited Members

object.GetType() , object.ToString() , object.Equals(object?) , object.Equals(object?, object?) , object.ReferenceEquals(object?, object?) , object.GetHashCode()

Fields

AgeString

Age String (AS).

public static readonly ValueRepresentation AgeString

Field Value

ValueRepresentation

ApplicationEntity

Application Entity (AE).

public static readonly ValueRepresentation ApplicationEntity

Field Value

ValueRepresentation

AttributeTag

Attribute Tag (AT).

public static readonly ValueRepresentation AttributeTag

Field Value

ValueRepresentation

CodeString

Code String (CS).

public static readonly ValueRepresentation CodeString

Field Value

ValueRepresentation

Date

Date (DA).

public static readonly ValueRepresentation Date

Field Value

ValueRepresentation

DateTime

Date Time (DT).

public static readonly ValueRepresentation DateTime

Field Value

ValueRepresentation

DecimalString

Decimal String (DS).

public static readonly ValueRepresentation DecimalString

Field Value

ValueRepresentation

FloatingPointDouble

Floating Point Double (FD).

public static readonly ValueRepresentation FloatingPointDouble

Field Value

ValueRepresentation

FloatingPointSingle

Floating Point Single (FL).

public static readonly ValueRepresentation FloatingPointSingle

Field Value

ValueRepresentation

IntegerString

Integer String (IS).

public static readonly ValueRepresentation IntegerString

Field Value

ValueRepresentation

ItemsSequence

Items sequence (SQ).

public static readonly ValueRepresentation ItemsSequence

Field Value

ValueRepresentation

LongString

Long String (LO).

public static readonly ValueRepresentation LongString

Field Value

ValueRepresentation

LongText

Long Text (LT).

public static readonly ValueRepresentation LongText

Field Value

ValueRepresentation

None

No Value Representation.

public static readonly ValueRepresentation None

Field Value

ValueRepresentation

OtherByte

Other Byte (OB).

public static readonly ValueRepresentation OtherByte

Field Value

ValueRepresentation

OtherDouble

Other Double (OD).

public static readonly ValueRepresentation OtherDouble

Field Value

ValueRepresentation

OtherFloat

Other Float (OF).

public static readonly ValueRepresentation OtherFloat

Field Value

ValueRepresentation

OtherLong

Other Long (OL).

public static readonly ValueRepresentation OtherLong

Field Value

ValueRepresentation

OtherVeryLong

Other Very Long (OV).

public static readonly ValueRepresentation OtherVeryLong

Field Value

ValueRepresentation

OtherWord

Other Word (OW).

public static readonly ValueRepresentation OtherWord

Field Value

ValueRepresentation

PersonName

Person Name (PN).

public static readonly ValueRepresentation PersonName

Field Value

ValueRepresentation

ShortString

Short String (SH).

public static readonly ValueRepresentation ShortString

Field Value

ValueRepresentation

ShortText

Short Text (ST).

public static readonly ValueRepresentation ShortText

Field Value

ValueRepresentation

SignedLong

Signed Long (SL).

public static readonly ValueRepresentation SignedLong

Field Value

ValueRepresentation

SignedShort

Signed Short (SS).

public static readonly ValueRepresentation SignedShort

Field Value

ValueRepresentation

SignedVeryLong

Signed Very Long (SV).

public static readonly ValueRepresentation SignedVeryLong

Field Value

ValueRepresentation

Time

Time (TM).

public static readonly ValueRepresentation Time

Field Value

ValueRepresentation

UniqueIdentifier

Unique Identifier (UI).

public static readonly ValueRepresentation UniqueIdentifier

Field Value

ValueRepresentation

UniversalResourceIdentifier

Universal Resource Identifier (URI) or Universal Resource Locator (URI) (UR).

public static readonly ValueRepresentation UniversalResourceIdentifier

Field Value

ValueRepresentation

Unknown

Unknown (UN).

public static readonly ValueRepresentation Unknown

Field Value

ValueRepresentation

UnlimitedCharacters

Unlimited Characters (UC).

public static readonly ValueRepresentation UnlimitedCharacters

Field Value

ValueRepresentation

UnlimitedText

Unlimited Text (UT).

public static readonly ValueRepresentation UnlimitedText

Field Value

ValueRepresentation

UnsignedLong

Unsigned Long (UL).

public static readonly ValueRepresentation UnsignedLong

Field Value

ValueRepresentation

UnsignedShort

Unsigned Short (US).

public static readonly ValueRepresentation UnsignedShort

Field Value

ValueRepresentation

UnsignedVeryLong

Unsigned Very Long (UV).

public static readonly ValueRepresentation UnsignedVeryLong

Field Value

ValueRepresentation

Properties

ByteSwap

Number of bytes to swap when changing endian representation of value. Usually equal to the Aspose.Medical.Dicom.ValueRepresentations.ValueRepresentation.UnitSize. Read-only System.Int32.

public int ByteSwap { get; }

Property Value

int

Code

Code used to represent VR. Read-only System.String.

public required string Code { get; init; }

Property Value

string

Is16BitLength

Specifies that length field of value is a 16-bit short integer. Read-only System.Boolean.

public bool Is16BitLength { get; }

Property Value

bool

IsMultiValue

Specifies whether the value can contain multiple items. Read-only System.Boolean.

public bool IsMultiValue { get; }

Property Value

bool

IsString

Specifies that the value is a string. Read-only System.Boolean.

public bool IsString { get; }

Property Value

bool

MaximumLength

Maximum length of a single value. Read-only System.UInt32.

public uint MaximumLength { get; }

Property Value

uint

Name

Descriptive name of VR. Read-only System.String.

public required string Name { get; init; }

Property Value

string

PaddingValue

Byte value used to pad value to even length. Read-only System.Byte.

public byte PaddingValue { get; }

Property Value

byte

UnitSize

Size of each individual value unit for fixed length value types. Read-only System.Int32.

public int UnitSize { get; }

Property Value

int

ValueType

Type used to represent VR value. Read-only System.Type.

public required Type ValueType { get; init; }

Property Value

Type

Methods

Equals(ValueRepresentation?)

public bool Equals(ValueRepresentation? other)

Parameters

other ValueRepresentation ?

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object ?

Returns

bool

Equals(object?, IEqualityComparer)

public bool Equals(object? other, IEqualityComparer comparer)

Parameters

other object ?

comparer IEqualityComparer

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

GetHashCode(IEqualityComparer)

public int GetHashCode(IEqualityComparer comparer)

Parameters

comparer IEqualityComparer

Returns

int

Parse(string)

Converts the string representation of a VR to its typed equivalent.

public static ValueRepresentation Parse(string vrCode)

Parameters

vrCode string

Two-character VR code. See valid codes in https://dicom.nema.org/medical/dicom/current/output/chtml/part05/sect_6.2.html#table_6.2-1 (VR name column).

Returns

ValueRepresentation

A Aspose.Medical.Dicom.ValueRepresentations.ValueRepresentation equivalent to the VR specified in vrCode.

Exceptions

ArgumentException

Invalid VR code.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(ValueRepresentation?, ValueRepresentation?)

Determines whether two specified objects have the same value.

public static bool operator ==(ValueRepresentation? left, ValueRepresentation? right)

Parameters

left ValueRepresentation ?

Left-hand side object to compare for equivalence.

right ValueRepresentation ?

Right-hand side object to compare for equivalence.

Returns

bool

true if the value of left is the same as the value of right; otherwise, false.

operator !=(ValueRepresentation?, ValueRepresentation?)

Determines whether two specified objects have different values.

public static bool operator !=(ValueRepresentation? left, ValueRepresentation? right)

Parameters

left ValueRepresentation ?

Left-hand side object to compare for non-equivalence.

right ValueRepresentation ?

Right-hand side object to compare for non-equivalence.

Returns

bool

true if the value of left is different from the value of right; otherwise, false. </valuerepresentation>