Class PlanSum

A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together.

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

Properties

Course

Used for navigating to the parent course.

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

PlanSetups

A collection of plan setups.

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

PlanSumComponents

A collection of plans in a plan sum.

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

Methods

GetPlanSumOperation(PlanSetup)

Returns the summing operation of the plan in the plan sum.

Declaration
public PlanSumOperation GetPlanSumOperation(PlanSetup planSetupInPlanSum)
Parameters
Type Name Description
PlanSetup planSetupInPlanSum

A plan that belongs to this plan sum, included in collection PlanSetups.
Returns
Type Description
PlanSumOperation

The summing operation of the plan in the plan sum.

GetPlanWeight(PlanSetup)

Returns the weight of the plan included in the sum.

Declaration
public double GetPlanWeight(PlanSetup planSetupInPlanSum)
Parameters
Type Name Description
PlanSetup planSetupInPlanSum

A plan that belongs to this plan sum, included in collectionPlanSetups.
Returns
Type Description
System.Double

The weight of the plan in the plan sum.

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