Class ProtocolPhasePrescription

Represents the prescriptions (plan objectives) of the clinical protocol.

Inheritance
System.Object
SerializableObject
ProtocolPhasePrescription
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class ProtocolPhasePrescription : SerializableObject, IXmlSerializable

Properties

ActualTotalDose

Actual total dose for this prescription

Declaration
public DoseValue ActualTotalDose { get; }
Property Value
Type Description
DoseValue

PrescModifier

Prescription Modifier.

Declaration
public PrescriptionModifier PrescModifier { get; }
Property Value
Type Description
PrescriptionModifier

PrescParameter

Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'.

Declaration
public double PrescParameter { get; }
Property Value
Type Description
System.Double

PrescType

Prescription Type.

Declaration
public PrescriptionType PrescType { get; }
Property Value
Type Description
PrescriptionType

StructureId

ID of structure to which this prescription is applied.

Declaration
public string StructureId { get; }
Property Value
Type Description
System.String

TargetFractionDose

Fraction dose in absolute units specified for this prescription.

Declaration
public DoseValue TargetFractionDose { get; }
Property Value
Type Description
DoseValue

TargetIsMet

Indicates whether the target is met. If this cannot be evaluated, the value is null.

Declaration
public bool? TargetIsMet { get; }
Property Value
Type Description
System.Nullable<System.Boolean>

TargetTotalDose

Total dose in absolute units specified for this prescription.

Declaration
public DoseValue TargetTotalDose { get; }
Property Value
Type Description
DoseValue

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

Implements

System.Xml.Serialization.IXmlSerializable