Class BeamDose

Represents a dose that is connected to a Beam.

Inheritance
System.Object
SerializableObject
ApiDataObject
Dose
BeamDose
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
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 BeamDose : Dose, IXmlSerializable

Methods

GetAbsoluteBeamDoseValue(DoseValue)

Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization.

Declaration
public DoseValue GetAbsoluteBeamDoseValue(DoseValue relative)
Parameters
Type Name Description
DoseValue relative

The relative dose value from this beam dose matrix to be converted.
Returns
Type Description
DoseValue

The absolute dose value per fraction. If the input value is undefined dose, returns undefined 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

Implements

System.Xml.Serialization.IXmlSerializable