Class ReferencePoint

A reference point associated with a patient.

Inheritance
System.Object
SerializableObject
ApiDataObject
ReferencePoint
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 ReferencePoint : ApiDataObject

Properties

DailyDoseLimit

Daily dose limit of this reference point.

Declaration
public DoseValue DailyDoseLimit { get; set; }
Property Value
Type Description
DoseValue

PatientVolumeId

The identifier of the patient volume for the reference point.

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

SessionDoseLimit

Session dose limit of this reference point.

Declaration
public DoseValue SessionDoseLimit { get; set; }
Property Value
Type Description
DoseValue

TotalDoseLimit

Total dose limit of this reference point.

Declaration
public DoseValue TotalDoseLimit { get; set; }
Property Value
Type Description
DoseValue

Methods

GetReferencePointLocation(PlanSetup)

The location of the reference point in mm.

Declaration
public VVector GetReferencePointLocation(PlanSetup planSetup)
Parameters
Type Name Description
PlanSetup planSetup

Plan setup that this reference point is connected to.
Returns
Type Description
VVector

Reference point location

HasLocation(PlanSetup)

Tests if a valid reference point location exists.

Declaration
public bool HasLocation(PlanSetup planSetup)
Parameters
Type Name Description
PlanSetup planSetup

Plan setup that this reference point is connected to
Returns
Type Description
System.Boolean

True if the reference point has location; false, otherwise

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