Class ReferencePoint

A reference point associated with a patient.

Inheritance

System.Object

SerializableObject

ApiDataObject

ReferencePoint

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Name

ApiDataObject.Comment

ApiDataObject.HistoryUserName

ApiDataObject.HistoryUserDisplayName

ApiDataObject.HistoryDateTime

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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, IXmlSerializable

Properties

DailyDoseLimit

Daily dose limit of this reference point.

Declaration

public DoseValue DailyDoseLimit { get; set; }

Property Value

Type	Description
DoseValue

Id

[Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point.

Declaration

public string Id { get; set; }

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

AddLocation(Image, Double, Double, Double, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image'

Declaration

public bool AddLocation(Image Image, double x, double y, double z, StringBuilder errorHint)

Parameters

Type	Name	Description
Image	Image	Image into which location is inserted
System.Double	x	x coordinate
System.Double	y	y coordinate
System.Double	z	z coordinate
System.Text.StringBuilder	errorHint	Holder for error message if addition fails

Returns

Type	Description
System.Boolean	true if addition succeeded, false otherwise

ChangeLocation(Image, Double, Double, Double, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image'

Declaration

public bool ChangeLocation(Image Image, double x, double y, double z, StringBuilder errorHint)

Parameters

Type	Name	Description
Image	Image	Image into which location is inserted
System.Double	x	x coordinate in mm
System.Double	y	y coordinate in mm
System.Double	z	z coordinate in mm
System.Text.StringBuilder	errorHint	Holder for error message if location cannot be changed

Returns

Type	Description
System.Boolean	true if location was succesfully changed, false otherwise

GetReferencePointLocation(Image)

3D location of this reference point in mm

Declaration

public VVector GetReferencePointLocation(Image Image)

Parameters

Type	Name	Description
Image	Image	Image for which the location is requested

Returns

Type	Description
VVector	Reference point location in 'Image', if exists, vector of NaN:s otherwise

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, if set for image, NaN:s otherwise

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

RemoveLocation(Image, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image'

Declaration

public bool RemoveLocation(Image Image, StringBuilder errorHint)

Parameters

Type	Name	Description
Image	Image	Image from which the location for the reference point is removed
System.Text.StringBuilder	errorHint	Holder for error message if removal fails

Returns

Type	Description
System.Boolean	true if location was removed or there was no location to remove, false if existing location could not be removed

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

ApiDataObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable