Class StructureCodeDictionary

Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented System.Collections.Generic.IReadOnlyDictionary<TKey, TValue> interface. Structure code schemes are managed in RT Administration.

Inheritance

System.Object

StructureCodeDictionary

Implements

System.Collections.Generic.IReadOnlyDictionary<System.String, StructureCode>

System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<System.String, StructureCode>>

System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, StructureCode>>

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: VMS.TPS.Common.Model.API

Assembly: VMS.TPS.Common.Model.API.dll

Syntax

public class StructureCodeDictionary : IReadOnlyDictionary<string, StructureCode>, IReadOnlyCollection<KeyValuePair<string, StructureCode>>, IEnumerable<KeyValuePair<string, StructureCode>>, IEnumerable

Fields

SchemeNameFma

The scheme name of the Foundational Model of Anatomy Ontology structure scheme.

Declaration

public const string SchemeNameFma = "FMA"

Field Value

Type	Description
System.String

SchemeNameRadLex

The scheme name of The RSNA RadLex radiology lexicon structure scheme.

Declaration

public const string SchemeNameRadLex = "RADLEX"

Field Value

Type	Description
System.String

SchemeNameSrt

The scheme name of the SNOMED RT structure scheme.

Declaration

public const string SchemeNameSrt = "SRT"

Field Value

Type	Description
System.String

SchemeNameVmsStructCode

The scheme name of the Varian 99VMS_STRUCTCODE structure scheme.

Declaration

public const string SchemeNameVmsStructCode = "99VMS_STRUCTCODE"

Field Value

Type	Description
System.String

Properties

Count

Gets the number of structure code object key/value pairs in this structure code dictionary.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Item[String]

Gets the structure code object associated with the specified structure code identifier (key).

Declaration

public StructureCode this[string key] { get; }

Parameters

Type	Name	Description
System.String	key

Property Value

Type	Description
StructureCode

Keys

Gets a collection containing the structure code identifiers in this structure code dictionary.

Declaration

public IEnumerable<string> Keys { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>

Name

The name of the structure code scheme.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Values

Gets a collection containing the structure codes in this structure code dictionary.

Declaration

public IEnumerable<StructureCode> Values { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<StructureCode>

Version

The version of the structure code scheme. May be an empty string, if not applicable to the scheme.

Declaration

public string Version { get; }

Property Value

Type	Description
System.String

Methods

ContainsKey(String)

Determines whether the scheme contains the specified key as an active structure code identifier.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Boolean

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<KeyValuePair<string, StructureCode>> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String, StructureCode>>

ToString()

Returns a string that represents this object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents this object.

Overrides

System.Object.ToString()

TryGetValue(String, out StructureCode)

Gets the structure code object associated with the specified structure code identifier (key).

Declaration

public bool TryGetValue(string key, out StructureCode value)

Parameters

Type	Name	Description
System.String	key	The structure code identifier.
StructureCode	value	When the method returns, contains the specified structure code object, if it is found, otherwise null.

Returns

Type	Description
System.Boolean	true if the requested structure code was found, otherwise false.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

Implements

System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>

System.Collections.Generic.IReadOnlyCollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable