Search Results for

    Show / Hide Table of Contents

    Class IonControlPoint

    Proton control point interface.

    Inheritance
    System.Object
    SerializableObject
    ControlPoint
    IonControlPoint
    Implements
    System.Xml.Serialization.IXmlSerializable
    Inherited Members
    ControlPoint.Beam
    ControlPoint.CollimatorAngle
    ControlPoint.GantryAngle
    ControlPoint.Index
    ControlPoint.JawPositions
    ControlPoint.LeafPositions
    ControlPoint.MetersetWeight
    ControlPoint.PatientSupportAngle
    ControlPoint.TableTopLateralPosition
    ControlPoint.TableTopLongitudinalPosition
    ControlPoint.TableTopVerticalPosition
    SerializableObject.GetSchema()
    SerializableObject.ReadXml(XmlReader)
    SerializableObject.ClearSerializationHistory()
    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 IonControlPoint : ControlPoint, IXmlSerializable

    Properties

    FinalSpotList

    Gets a cached copy of the post-processed final spot list.

    Declaration
    public IonSpotCollection FinalSpotList { get; }
    Property Value
    Type Description
    IonSpotCollection

    LateralSpreadingDeviceSettings

    The lateral spreading device settings.

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

    NominalBeamEnergy

    Nominal beam energy, in megavolts.

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

    NumberOfPaintings

    The number of times the scan pattern shall be applied at the current control point.

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

    RangeModulatorSettings

    The range modulator settings.

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

    RangeShifterSettings

    The range shifter settings.

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

    RawSpotList

    Gets a cached copy of the raw spot list.

    Declaration
    public IonSpotCollection RawSpotList { get; }
    Property Value
    Type Description
    IonSpotCollection

    ScanningSpotSizeX

    The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm).

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

    ScanningSpotSizeY

    The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm).

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

    ScanSpotTuneId

    User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined.

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

    SnoutPosition

    The snout position, in mm.

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

    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
    ControlPoint.WriteXml(XmlWriter)

    Implements

    System.Xml.Serialization.IXmlSerializable
    In This Article
    Back to top