Class ExternalBeamMachineParameters

The parameters for the external beam treatment unit.

Inheritance
System.Object
ExternalBeamMachineParameters
Inherited Members
System.Object.ToString()
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.Types
Assembly: VMS.TPS.Common.Model.Types.dll
Syntax
public class ExternalBeamMachineParameters

Constructors

ExternalBeamMachineParameters(String)

Assigns the Treatment Unit ID to the properties. Rest of the properties are left empty. These parameters will work for Halcyon machine when adding imaging setup or Fixed Sequence beam. For other types of beams, define all properties.

Declaration
public ExternalBeamMachineParameters(string machineId)
Parameters
Type Name Description
System.String machineId

The treatment unit identifier.

ExternalBeamMachineParameters(String, String, Int32, String, String)

Assigns the parameters to the properties for external beams.

Declaration
public ExternalBeamMachineParameters(string machineId, string energyModeId, int doseRate, string techniqueId, string primaryFluenceModeId)
Parameters
Type Name Description
System.String machineId

The treatment unit identifier.
System.String energyModeId

The energy mode identifier. For example, "6X", or "18X".
System.Int32 doseRate

Dose rate value.
System.String techniqueId

Technique identifier. Typically "STATIC" or "ARC".
System.String primaryFluenceModeId

Primary Fluence Mode ID. Acceptable values are: null, empty string, "SRS","FFF".

Properties

DoseRate

Dose rate value.

Declaration
public int DoseRate { get; set; }
Property Value
Type Description
System.Int32

EnergyModeId

The energy mode identifier. For example, "6X", or "18X".

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

MachineId

The treatment unit identifier.

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

MLCId

Optional MLC identifier. If null (which is the default) then the single MLC of the treatment unit is selected.

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

PrimaryFluenceModeId

Primary Fluence Mode identifier. Acceptable values are: null, empty string, "SRS","FFF".

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

TechniqueId

Technique identifier. Typically "STATIC" or "ARC".

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