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

PlanningItem.GetClinicalGoals()

PlanningItem.GetDVHCumulativeData(Structure, DoseValuePresentation, VolumePresentation, Double)

PlanningItem.GetDoseAtVolume(Structure, Double, VolumePresentation, DoseValuePresentation)

PlanningItem.GetVolumeAtDose(Structure, DoseValue, VolumePresentation)

PlanningItem.Course

PlanningItem.CreationDateTime

PlanningItem.Dose

PlanningItem.DoseValuePresentation

PlanningItem.StructureSet

PlanningItem.StructuresSelectedForDvh

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

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 PlanSum : PlanningItem, IXmlSerializable

Properties

Id

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

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Name

[Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

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

AddItem(PlanningItem)

[Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters (PlanSumOperation set to Addition, Plan weight is 1.0). If item to be added is a plan sum, all plans of the plan sum will be added.

Declaration

public void AddItem(PlanningItem pi)

Parameters

Type	Name	Description
PlanningItem	pi	Planning item, can be plan setup or plan sum.

AddItem(PlanningItem, PlanSumOperation, Double)

[Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added.

Declaration

public void AddItem(PlanningItem pi, PlanSumOperation operation, double planWeight)

Parameters

Type	Name	Description
PlanningItem	pi	Planning item, can be plan setup or plan sum.
PlanSumOperation	operation	The summing operation of the plan in the plan sum.
System.Double	planWeight	Plan weight

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.

RemoveItem(PlanningItem)

[Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed.

Declaration

public void RemoveItem(PlanningItem pi)

Parameters

Type	Name	Description
PlanningItem	pi	Planning item, can be plan setup or plan sum.

SetPlanSumOperation(PlanSetup, PlanSumOperation)

[Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum.

Declaration

public void SetPlanSumOperation(PlanSetup planSetupInPlanSum, PlanSumOperation operation)

Parameters

Type	Name	Description
PlanSetup	planSetupInPlanSum	A plan that belongs to this plan sum, included in collection PlanSetups.
PlanSumOperation	operation	The summing operation of the plan in the plan sum.

SetPlanWeight(PlanSetup, Double)

[Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum.

Declaration

public void SetPlanWeight(PlanSetup planSetupInPlanSum, double weight)

Parameters

Type	Name	Description
PlanSetup	planSetupInPlanSum	A plan that belongs to this plan sum, included in collectionPlanSetups.
System.Double	weight	Plan weight

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

PlanningItem.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable