Class RTPrescription

Represents a prescription.

Inheritance

System.Object

SerializableObject

ApiDataObject

RTPrescription

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

Properties

BolusFrequency

Bolus frequency (how often the bolus is present in the field). For example, daily.

Declaration

public string BolusFrequency { get; }

Property Value

Type	Description
System.String

BolusThickness

Thickness of the bolus to be used.

Declaration

public string BolusThickness { get; }

Property Value

Type	Description
System.String

Energies

The energies in the prescription.

Declaration

public IEnumerable<string> Energies { get; }

Property Value

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

EnergyModes

The energy modes in the prescription.

Declaration

public IEnumerable<string> EnergyModes { get; }

Property Value

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

Gating

Gating information.

Declaration

public string Gating { get; }

Property Value

Type	Description
System.String

LatestRevision

Gets the latest revision of the current RT prescription.

Declaration

public RTPrescription LatestRevision { get; }

Property Value

Type	Description
RTPrescription

Notes

Additional notes.

Declaration

public string Notes { get; }

Property Value

Type	Description
System.String

NumberOfFractions

Number of fractions, optional.

Declaration

public int? NumberOfFractions { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

OrgansAtRisk

Gets the organs at risk of the current RT prescription.

Declaration

public IEnumerable<RTPrescriptionOrganAtRisk> OrgansAtRisk { get; }

Property Value

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

PhaseType

Type of the phase (primary/boost).

Declaration

public string PhaseType { get; }

Property Value

Type	Description
System.String

PredecessorPrescription

Gets the previous version of the RT prescription if it exists.

Declaration

public RTPrescription PredecessorPrescription { get; }

Property Value

Type	Description
RTPrescription

RevisionNumber

Revision number of the prescription.

Declaration

public int RevisionNumber { get; }

Property Value

Type	Description
System.Int32

SimulationNeeded

Indicates if simulations need to be done before treatment planning.

Declaration

public bool? SimulationNeeded { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Site

The treatment site in the prescription.

Declaration

public string Site { get; }

Property Value

Type	Description
System.String

Status

Prescription status.

Declaration

public string Status { get; }

Property Value

Type	Description
System.String

TargetConstraintsWithoutTargetLevel

Coverage constraints for targets with no prescribed dose.

Declaration

public IEnumerable<RTPrescriptionTargetConstraints> TargetConstraintsWithoutTargetLevel { get; }

Property Value

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

Targets

Gets the targets of the current prescription.

Declaration

public IEnumerable<RTPrescriptionTarget> Targets { get; }

Property Value

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

Technique

Treatment technique to be used.

Declaration

public string Technique { get; }

Property Value

Type	Description
System.String

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