Class IonBeamParameters

An editable copy of the parameters of a proton beam.

Inheritance
System.Object
BeamParameters
IonBeamParameters
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.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class IonBeamParameters : BeamParameters
Remarks

To apply the parameters, call the ApplyParameters(BeamParameters) method of the IonBeam class. The parameters contained in this class are simply copies, and they do not reflect the current state of the data model.

Properties

ControlPoints

Editable control point parameters copied from the treatment beam.

Declaration
public IEnumerable<IonControlPointParameters> ControlPoints { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<IonControlPointParameters>

IonControlPointPairs

A copy of editable control point pairs.

Declaration
public IonControlPointPairCollection IonControlPointPairs { get; }
Property Value
Type Description
IonControlPointPairCollection

PreSelectedRangeShifter1Id

ID of the pre-selected range shifter 1 in the field.

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

PreSelectedRangeShifter1Setting

Setting of the pre-selected range shifter 1 in the field.

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

PreSelectedRangeShifter2Id

ID of the pre-selected range shifter 2 in the field.

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

PreSelectedRangeShifter2Setting

Setting of the pre-selected range shifter 2 in the field.

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

SnoutId

The snout identifier. Returns null if undefined.

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

SnoutPosition

Snout position in centimeters.

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

TargetStructure

Target structure of the field.

Declaration
public Structure TargetStructure { get; set; }
Property Value
Type Description
Structure