Class FieldReferencePoint

This object links a treatment beam to a reference point.

Inheritance
System.Object
SerializableObject
ApiDataObject
FieldReferencePoint
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 FieldReferencePoint : ApiDataObject, IXmlSerializable

Properties

EffectiveDepth

The effective depth of the field reference point. For arc fields this is the average value over the span of the arc.

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

FieldDose

The field dose.

Declaration
public DoseValue FieldDose { get; }
Property Value
Type Description
DoseValue

IsFieldDoseNominal

Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation.”

Declaration
public bool IsFieldDoseNominal { get; }
Property Value
Type Description
System.Boolean

IsPrimaryReferencePoint

Checks if the reference point is primary.

Declaration
public bool IsPrimaryReferencePoint { get; }
Property Value
Type Description
System.Boolean

ReferencePoint

Used for navigating to an underlying reference point.

Declaration
public ReferencePoint ReferencePoint { get; }
Property Value
Type Description
ReferencePoint

RefPointLocation

The location of the reference point.

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

SSD

The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc.

Declaration
public double SSD { 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

Implements

System.Xml.Serialization.IXmlSerializable