Class BrachyTreatmentUnit

Represents a brachytherapy afterloader.

Inheritance

System.Object

SerializableObject

ApiDataObject

BrachyTreatmentUnit

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Id

ApiDataObject.Name

ApiDataObject.Comment

ApiDataObject.HistoryUserName

ApiDataObject.HistoryUserDisplayName

ApiDataObject.HistoryDateTime

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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 BrachyTreatmentUnit : ApiDataObject, IXmlSerializable

Properties

DoseRateMode

The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR".

Declaration

public string DoseRateMode { get; }

Property Value

Type	Description
System.String

DwellTimeResolution

The dwell time resolution supported by this treatment unit in seconds.

Declaration

public double DwellTimeResolution { get; }

Property Value

Type	Description
System.Double

MachineInterface

The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type).

Declaration

public string MachineInterface { get; }

Property Value

Type	Description
System.String

MachineModel

The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus".

Declaration

public string MachineModel { get; }

Property Value

Type	Description
System.String

MaxDwellTimePerChannel

The maximum combined dwell time in a single channel in seconds.

Declaration

public double MaxDwellTimePerChannel { get; }

Property Value

Type	Description
System.Double

MaxDwellTimePerPos

The maximum dwell time in a single dwell position in seconds.

Declaration

public double MaxDwellTimePerPos { get; }

Property Value

Type	Description
System.Double

MaxDwellTimePerTreatment

The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds.

Declaration

public double MaxDwellTimePerTreatment { get; }

Property Value

Type	Description
System.Double

MaximumChannelLength

The maximum channel length supported by this treatment unit in millimeters.

Declaration

public double MaximumChannelLength { get; }

Property Value

Type	Description
System.Double

MaximumDwellPositionsPerChannel

The maximum number of dwell positions per channel supported by this treatment unit.

Declaration

public int MaximumDwellPositionsPerChannel { get; }

Property Value

Type	Description
System.Int32

MaximumStepSize

The maximum distance between adjacent source positions in millimeters.

Declaration

public double MaximumStepSize { get; }

Property Value

Type	Description
System.Double

MinAllowedSourcePos

The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen.

Declaration

public double MinAllowedSourcePos { get; }

Property Value

Type	Description
System.Double

MinimumChannelLength

The minimum channel length supported by this treatment unit in millimeters.

Declaration

public double MinimumChannelLength { get; }

Property Value

Type	Description
System.Double

MinimumStepSize

The minimum distance between adjacent source positions in millimeters.

Declaration

public double MinimumStepSize { get; }

Property Value

Type	Description
System.Double

NumberOfChannels

The number of channels in this treatment unit.

Declaration

public int NumberOfChannels { get; }

Property Value

Type	Description
System.Int32

SourceCenterOffsetFromTip

The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation.

Declaration

public double SourceCenterOffsetFromTip { get; }

Property Value

Type	Description
System.Double

SourceMovementType

The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING".

Declaration

public string SourceMovementType { get; }

Property Value

Type	Description
System.String

StepSizeResolution

The default step size resolution for this treatment unit in millimeters.

Declaration

public double StepSizeResolution { get; }

Property Value

Type	Description
System.Double

Methods

GetActiveRadioactiveSource()

Returns the active radioactive source of this treatment unit.

Declaration

public RadioactiveSource GetActiveRadioactiveSource()

Returns

Type	Description
RadioactiveSource	A RadioactiveSource object if the treatment unit has a source installed. Otherwise null.

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

ApiDataObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable