Class PlanningItem

Inheritance

System.Object

SerializableObject

ApiDataObject

PlanningItem

Inherited Members

ApiDataObject.Id

ApiDataObject.Name

ApiDataObject.Comment

ApiDataObject.HistoryUserName

ApiDataObject.HistoryDateTime

ApiDataObject.HistoryUserDisplayName

SerializableObject.IsLive

SerializableObject.GetSchema()

SerializableObject.ReadXml(Xml.XmlReader)

SerializableObject.WriteXml(Xml.XmlWriter)

SerializableObject.ClearSerializationHistory()

Namespace:ESAPIX.Facade.API

Assembly:cs.temp.dll.dll

Syntax

public class PlanningItem : ApiDataObject, Xml.Serialization.IXmlSerializable

Constructors

PlanningItem()

Declaration

public PlanningItem()

PlanningItem()

Declaration

public PlanningItem()

PlanningItem()

Declaration

public PlanningItem()

PlanningItem()

Declaration

public PlanningItem()

PlanningItem()

Declaration

public PlanningItem()

PlanningItem()

Declaration

public PlanningItem()

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

PlanningItem(Object)

Declaration

public PlanningItem(dynamic client)

Parameters

Type	Name	Description
System.Object	client

Properties

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

CreationDateTime

Declaration

public DateTime? CreationDateTime { get; set; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

Dose

Declaration

public PlanningItemDose Dose { get; set; }

Property Value

Type	Description
PlanningItemDose

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

DoseValuePresentation

Declaration

public Common.Model.Types.DoseValuePresentation DoseValuePresentation { get; set; }

Property Value

Type	Description
VMS.TPS.Common.Model.Types.DoseValuePresentation

StructureSet

Declaration

public StructureSet StructureSet { get; set; }

Property Value

Type	Description
StructureSet

StructuresSelectedForDvh

Declaration

public IEnumerable<Structure> StructuresSelectedForDvh { get; set; }

Property Value

Type	Description
IEnumerable<Structure>

StructuresSelectedForDvh

Declaration

public IEnumerable<Structure> StructuresSelectedForDvh { get; set; }

Property Value

Type	Description
IEnumerable<Structure>

StructuresSelectedForDvh

Declaration

public IEnumerable<Structure> StructuresSelectedForDvh { get; set; }

Property Value

Type	Description
IEnumerable<Structure>

Methods

GetDoseAtVolume(Structure, Double, Common.Model.Types.VolumePresentation, Common.Model.Types.DoseValuePresentation)

Declaration

public Common.Model.Types.DoseValue GetDoseAtVolume(Structure structure, double volume, Common.Model.Types.VolumePresentation volumePresentation, Common.Model.Types.DoseValuePresentation requestedDosePresentation)

Parameters

Type	Name	Description
Structure	structure
System.Double	volume
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
VMS.TPS.Common.Model.Types.DoseValuePresentation	requestedDosePresentation

Returns

Type	Description
VMS.TPS.Common.Model.Types.DoseValue

GetDoseAtVolume(Structure, Double, Common.Model.Types.VolumePresentation, Common.Model.Types.DoseValuePresentation)

Declaration

public Common.Model.Types.DoseValue GetDoseAtVolume(Structure structure, double volume, Common.Model.Types.VolumePresentation volumePresentation, Common.Model.Types.DoseValuePresentation requestedDosePresentation)

Parameters

Type	Name	Description
Structure	structure
System.Double	volume
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
VMS.TPS.Common.Model.Types.DoseValuePresentation	requestedDosePresentation

Returns

Type	Description
VMS.TPS.Common.Model.Types.DoseValue

GetDoseAtVolume(Structure, Double, Common.Model.Types.VolumePresentation, Common.Model.Types.DoseValuePresentation)

Declaration

public Common.Model.Types.DoseValue GetDoseAtVolume(Structure structure, double volume, Common.Model.Types.VolumePresentation volumePresentation, Common.Model.Types.DoseValuePresentation requestedDosePresentation)

Parameters

Type	Name	Description
Structure	structure
System.Double	volume
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
VMS.TPS.Common.Model.Types.DoseValuePresentation	requestedDosePresentation

Returns

Type	Description
VMS.TPS.Common.Model.Types.DoseValue

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetDVHCumulativeData(Structure, Common.Model.Types.DoseValuePresentation, Common.Model.Types.VolumePresentation, Double)

Declaration

public DVHData GetDVHCumulativeData(Structure structure, Common.Model.Types.DoseValuePresentation dosePresentation, Common.Model.Types.VolumePresentation volumePresentation, double binWidth)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValuePresentation	dosePresentation
VMS.TPS.Common.Model.Types.VolumePresentation	volumePresentation
System.Double	binWidth

Returns

Type	Description
DVHData

GetVolumeAtDose(Structure, Common.Model.Types.DoseValue, Common.Model.Types.VolumePresentation)

Declaration

public double GetVolumeAtDose(Structure structure, Common.Model.Types.DoseValue dose, Common.Model.Types.VolumePresentation requestedVolumePresentation)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
VMS.TPS.Common.Model.Types.VolumePresentation	requestedVolumePresentation

Returns

Type	Description
System.Double

GetVolumeAtDose(Structure, Common.Model.Types.DoseValue, Common.Model.Types.VolumePresentation)

Declaration

public double GetVolumeAtDose(Structure structure, Common.Model.Types.DoseValue dose, Common.Model.Types.VolumePresentation requestedVolumePresentation)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
VMS.TPS.Common.Model.Types.VolumePresentation	requestedVolumePresentation

Returns

Type	Description
System.Double

GetVolumeAtDose(Structure, Common.Model.Types.DoseValue, Common.Model.Types.VolumePresentation)

Declaration

public double GetVolumeAtDose(Structure structure, Common.Model.Types.DoseValue dose, Common.Model.Types.VolumePresentation requestedVolumePresentation)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
VMS.TPS.Common.Model.Types.VolumePresentation	requestedVolumePresentation

Returns

Type	Description
System.Double