/DICOM/DicomVR.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.Text;

namespace Dicom {
	/// <summary>DICOM Value Representation</summary>
	public sealed class DicomVR {
		private const byte PadZero = 0x00;
		private const byte PadSpace = 0x20;

		private DicomVR() {
		}

		/// <summary>Code used to represent VR.</summary>
		public string Code {
			get;
			private set;
		}

		/// <summary>Descriptive name of VR.</summary>
		public string Name {
			get;
			private set;
		}

		/// <summary>Value is a string.</summary>
		public bool IsString {
			get;
			private set;
		}

		/// <summary>String is encoded using the specified character set.</summary>
		public bool IsStringEncoded {
			get;
			private set;
		}

		/// <summary>Length field of value is a 16-bit short integer.</summary>
		public bool Is16bitLength {
			get;
			private set;
		}

		/// <summary>Value can contain multiple items.</summary>
		public bool IsMultiValue {
			get;
			private set;
		}

		/// <summary>Byte value used to pad value to even length.</summary>
		public byte PaddingValue {
			get;
			private set;
		}

		/// <summary>Maximum length of single value.</summary>
		public uint MaximumLength {
			get;
			private set;
		}

		/// <summary>Size of each individual value unit.</summary>
		public int UnitSize {
			get;
			private set;
		}

		/// <summary>Number of bytes to swap when changing endian representation of value.</summary>
		public int ByteSwap {
			get;
			private set;
		}

		/// <summary>Type used to represent VR value.</summary>
		public Type ValueType {
			get;
			private set;
		}

		/// <summary>
		/// Serializes VR code
		/// </summary>
		/// <param name="info"></param>
		/// <param name="context"></param>
		public void GetObjectData(SerializationInfo info, StreamingContext context) {
			info.AddValue("vr", Code);
		}

		/// <summary>
		/// 
		/// </summary>
		/// <returns></returns>
		public override string ToString() {
			return Code;
		}

		/// <summary>
		/// Get VR for given string value.
		/// </summary>
		/// <param name="vr">String representation of VR</param>
		/// <returns>VR</returns>
		public static DicomVR Parse(string vr) {
			switch (vr) {
			case "NONE": return DicomVR.NONE;
			case "AE": return DicomVR.AE;
			case "AS": return DicomVR.AS;
			case "AT": return DicomVR.AT;
			case "CS": return DicomVR.CS;
			case "DA": return DicomVR.DA;
			case "DS": return DicomVR.DS;
			case "DT": return DicomVR.DT;
			case "FD": return DicomVR.FD;
			case "FL": return DicomVR.FL;
			case "IS": return DicomVR.IS;
			case "LO": return DicomVR.LO;
			case "LT": return DicomVR.LT;
			case "OB": return DicomVR.OB;
			case "OF": return DicomVR.OF;
			case "OW": return DicomVR.OW;
			case "PN": return DicomVR.PN;
			case "SH": return DicomVR.SH;
			case "SL": return DicomVR.SL;
			case "SQ": return DicomVR.SQ;
			case "SS": return DicomVR.SS;
			case "ST": return DicomVR.ST;
			case "TM": return DicomVR.TM;
			case "UI": return DicomVR.UI;
			case "UL": return DicomVR.UL;
			case "UN": return DicomVR.UN;
			case "US": return DicomVR.US;
			case "UT": return DicomVR.UT;
			default:
				throw new DicomDataException("Unknown VR: '" + vr + "'");
			}
		}

		/// <summary>No VR</summary>
		public readonly static DicomVR NONE = new DicomVR {
			Code = "NONE",
			Name = "No Value Representation",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = false,
			PaddingValue = PadZero,
			MaximumLength = 0,
			UnitSize = 0,
			ByteSwap = 0,
			ValueType = typeof(object)
		};

		/// <summary>Application Entity</summary>
		public readonly static DicomVR AE = new DicomVR {
			Code = "AE",
			Name = "Application Entity",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 16,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Age String</summary>
		public readonly static DicomVR AS = new DicomVR {
			Code = "AS",
			Name = "Age String",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 4,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Attribute Tag</summary>
		public readonly static DicomVR AT = new DicomVR {
			Code = "AT",
			Name = "Attribute Tag",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 4,
			UnitSize = 4,
			ByteSwap = 2,
			ValueType = typeof(DicomTag)
		};

		/// <summary>Code String</summary>
		public readonly static DicomVR CS = new DicomVR {
			Code = "CS",
			Name = "Code String",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 16,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Date</summary>
		public readonly static DicomVR DA = new DicomVR {
			Code = "DA",
			Name = "Date",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 8,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(DateTime)
		};

		/// <summary>Decimal String</summary>
		public readonly static DicomVR DS = new DicomVR {
			Code = "DS",
			Name = "Decimal String",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 16,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(decimal)
		};

		/// <summary>Date Time</summary>
		public readonly static DicomVR DT = new DicomVR {
			Code = "DT",
			Name = "Date Time",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 26,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(DateTime)
		};

		/// <summary>Floating Point Double</summary>
		public readonly static DicomVR FD = new DicomVR {
			Code = "FD",
			Name = "Floating Point Double",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 8,
			UnitSize = 8,
			ByteSwap = 8,
			ValueType = typeof(double)
		};

		/// <summary>Floating Point Single</summary>
		public readonly static DicomVR FL = new DicomVR {
			Code = "FL",
			Name = "Floating Point Single",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 4,
			UnitSize = 4,
			ByteSwap = 4,
			ValueType = typeof(float)
		};

		/// <summary>Integer String</summary>
		public readonly static DicomVR IS = new DicomVR {
			Code = "IS",
			Name = "Integer String",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 12,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(int)
		};

		/// <summary>Long String</summary>
		public readonly static DicomVR LO = new DicomVR {
			Code = "LO",
			Name = "Long String",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = true,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 64,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Long Text</summary>
		public readonly static DicomVR LT = new DicomVR {
			Code = "LT",
			Name = "Long Text",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = true,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 10240,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Other Byte</summary>
		public readonly static DicomVR OB = new DicomVR {
			Code = "OB",
			Name = "Other Byte",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 0,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(byte[])
		};

		/// <summary>Other Float</summary>
		public readonly static DicomVR OF = new DicomVR {
			Code = "OF",
			Name = "Other Float",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 0,
			UnitSize = 4,
			ByteSwap = 4,
			ValueType = typeof(float[])
		};

		/// <summary>Other Word</summary>
		public readonly static DicomVR OW = new DicomVR {
			Code = "OW",
			Name = "Other Word",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 0,
			UnitSize = 2,
			ByteSwap = 2,
			ValueType = typeof(ushort)
		};

		/// <summary>Person Name</summary>
		public readonly static DicomVR PN = new DicomVR {
			Code = "PN",
			Name = "Person Name",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = true,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 64,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(String)
		};

		/// <summary>Short String</summary>
		public readonly static DicomVR SH = new DicomVR {
			Code = "SH",
			Name = "Short String",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 16,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Signed Long</summary>
		public readonly static DicomVR SL = new DicomVR {
			Code = "SL",
			Name = "Signed Long",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 4,
			UnitSize = 4,
			ByteSwap = 4,
			ValueType = typeof(int)
		};

		/// <summary>Sequence of Items</summary>
		public readonly static DicomVR SQ = new DicomVR {
			Code = "SQ",
			Name = "Sequence of Items",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 0,
			UnitSize = 0,
			ByteSwap = 0,
			//ValueType = typeof(IList<DicomDataset>)
		};

		/// <summary>Signed Short</summary>
		public readonly static DicomVR SS = new DicomVR {
			Code = "SS",
			Name = "Signed Short",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 2,
			UnitSize = 2,
			ByteSwap = 2,
			ValueType = typeof(short)
		};

		/// <summary>Short Text</summary>
		public readonly static DicomVR ST = new DicomVR {
			Code = "ST",
			Name = "Short Text",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = true,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 1024,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Time</summary>
		public readonly static DicomVR TM = new DicomVR {
			Code = "TM",
			Name = "Time",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadSpace,
			MaximumLength = 16,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(DateTime)
		};

		/// <summary>Unique Identifier</summary>
		public readonly static DicomVR UI = new DicomVR {
			Code = "UI",
			Name = "Unique Identifier",
			IsString = true,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 64,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};

		/// <summary>Unsigned Long</summary>
		public readonly static DicomVR UL = new DicomVR {
			Code = "UL",
			Name = "Unsigned Long",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 4,
			UnitSize = 4,
			ByteSwap = 4,
			ValueType = typeof(uint)
		};

		/// <summary>Unknown</summary>
		public readonly static DicomVR UN = new DicomVR {
			Code = "UN",
			Name = "Unknown",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = false,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 0,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(byte[])
		};

		/// <summary>Unsigned Short</summary>
		public readonly static DicomVR US = new DicomVR {
			Code = "US",
			Name = "Unsigned Short",
			IsString = false,
			IsStringEncoded = false,
			Is16bitLength = true,
			IsMultiValue = true,
			PaddingValue = PadZero,
			MaximumLength = 2,
			UnitSize = 2,
			ByteSwap = 2,
			ValueType = typeof(ushort)
		};

		/// <summary>Unlimited Text</summary>
		public readonly static DicomVR UT = new DicomVR {
			Code = "UT",
			Name = "Unlimited Text",
			IsString = true,
			IsStringEncoded = true,
			Is16bitLength = false,
			IsMultiValue = false,
			PaddingValue = PadSpace,
			MaximumLength = 0,
			UnitSize = 1,
			ByteSwap = 1,
			ValueType = typeof(string)
		};
	}
}