Class EstimatedDVH

Represents an estimated Dose Volume Histogram (DVH) curve.

Inheritance

System.Object

SerializableObject

ApiDataObject

EstimatedDVH

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 EstimatedDVH : ApiDataObject, IXmlSerializable

Properties

CurveData

The points of the estimated DVH curve.

Declaration

public DVHPoint[] CurveData { get; }

Property Value

Type	Description
DVHPoint[]

PlanSetup

Parent plan.

Declaration

public PlanSetup PlanSetup { get; }

Property Value

Type	Description
PlanSetup

PlanSetupId

ID of the parent plan.

Declaration

public string PlanSetupId { get; }

Property Value

Type	Description
System.String

Structure

Parent structure.

Declaration

public Structure Structure { get; }

Property Value

Type	Description
Structure

StructureId

ID of the parent structure.

Declaration

public string StructureId { get; }

Property Value

Type	Description
System.String

TargetDoseLevel

Dose level of the associated target structure.

Declaration

public DoseValue TargetDoseLevel { get; }

Property Value

Type	Description
DoseValue

Type

Type of DVH estimate curve.

Declaration

public DVHEstimateType Type { get; }

Property Value

Type	Description
DVHEstimateType

Methods

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