Class RadioactiveSourceModel

The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters.

Inheritance
System.Object
SerializableObject
ApiDataObject
RadioactiveSourceModel
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class RadioactiveSourceModel : ApiDataObject, IXmlSerializable

Properties

ActiveSize

The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length.

Declaration
public VVector ActiveSize { get; }
Property Value
Type Description
VVector

ActivityConversionFactor

The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi].

Declaration
public double ActivityConversionFactor { get; }
Property Value
Type Description
System.Double

CalculationModel

The dose calculation type used with this source model. Possible values are "Point source" and "Linear source".

Declaration
public string CalculationModel { get; }
Property Value
Type Description
System.String

DoseRateConstant

A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U).

Declaration
public double DoseRateConstant { get; }
Property Value
Type Description
System.Double

HalfLife

The half life of the isotope in seconds.

Declaration
public double HalfLife { get; }
Property Value
Type Description
System.Double

LiteratureReference

The reference to the scientific publications on which the source model is based.

Declaration
public string LiteratureReference { get; }
Property Value
Type Description
System.String

Manufacturer

The manufacturer of the modeled radioactive source.

Declaration
public string Manufacturer { get; }
Property Value
Type Description
System.String

SourceType

The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere".

Declaration
public string SourceType { get; }
Property Value
Type Description
System.String

Status

The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired".

Declaration
public string Status { get; }
Property Value
Type Description
System.String

StatusDate

The time when the status of the source model was set.

Declaration
public DateTime? StatusDate { get; }
Property Value
Type Description
System.Nullable<System.DateTime>

StatusUserName

The name of the user who last set the status of the source model.

Declaration
public string StatusUserName { get; }
Property Value
Type Description
System.String

Methods

WriteXml(XmlWriter)

Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see System.Xml.Serialization.XmlSerializer.

Declaration
public override void WriteXml(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter stream, to which the object is serialized.
Overrides

Implements

System.Xml.Serialization.IXmlSerializable