Class PlanningItem

Common properties of a treatment plan and a plan sum.

Inheritance

System.Object

SerializableObject

ApiDataObject

PlanningItem

PlanSetup

PlanSum

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Id

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 PlanningItem : ApiDataObject

Properties

Course

Used for navigating to parent course.

Declaration

public Course Course { get; }

Property Value

Type	Description
Course

CreationDateTime

The date when this object was created.

Declaration

public DateTime? CreationDateTime { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Dose

The total dose. The total dose is the dose of all planned fractions together.

Declaration

public PlanningItemDose Dose { get; }

Property Value

Type	Description
PlanningItemDose

DoseValuePresentation

The presentation of the dose as absolute or relative.

Declaration

public DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
DoseValuePresentation

StructureSet

The structure set.

Declaration

public StructureSet StructureSet { get; }

Property Value

Type	Description
StructureSet

StructuresSelectedForDvh

The collection of the structures that have been selected for DVH evaluation in Eclipse.

Declaration

public IEnumerable<Structure> StructuresSelectedForDvh { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<Structure>

Methods

GetClinicalGoals()

Get the list of clinical goals assigned to a planning item.

Declaration

public List<ClinicalGoal> GetClinicalGoals()

Returns

Type	Description
System.Collections.Generic.List<ClinicalGoal>	The list of clinical goals attached to the plan.

GetDoseAtVolume(Structure, Double, VolumePresentation, DoseValuePresentation)

Gets the dose at a volume.

Declaration

public DoseValue GetDoseAtVolume(Structure structure, double volume, VolumePresentation volumePresentation, DoseValuePresentation requestedDosePresentation)

Parameters

Type	Name	Description
Structure	structure	Structure for which the value is requested.
System.Double	volume	Volume at which the dose is requested.
VolumePresentation	volumePresentation	Presentation mode of the volume parameter.
DoseValuePresentation	requestedDosePresentation	Requested dose presentation mode (absolute or relative).

Returns

Type	Description
DoseValue	The dose value at the given structure volume.

GetDVHCumulativeData(Structure, DoseValuePresentation, VolumePresentation, Double)

Returns cumulative Dose Volume Histogram (DVH) data.

Declaration

public DVHData GetDVHCumulativeData(Structure structure, DoseValuePresentation dosePresentation, VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure	Structure for which the DVH data is requested.
DoseValuePresentation	dosePresentation	Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums.
VolumePresentation	volumePresentation	Requested volume presentation mode.
System.Double	binWidth	Requested width of the bin.

Returns

Type	Description
DVHData	DVHData object that contains the requested DVH information or null if DVH calculation was not possible.

GetVolumeAtDose(Structure, DoseValue, VolumePresentation)

Gets the volume at the dose.

Declaration

public double GetVolumeAtDose(Structure structure, DoseValue dose, VolumePresentation requestedVolumePresentation)

Parameters

Type	Name	Description
Structure	structure	Structure for which the value is requested.
DoseValue	dose	Dose at which the volume is requested.
VolumePresentation	requestedVolumePresentation	Requested volume presentation mode.

Returns

Type	Description
System.Double	The volume at the given dose.

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