Class CalculateBrachy3DDoseResult

Brachy 3D dose calculation result

Inheritance

System.Object

SerializableObject

CalculateBrachy3DDoseResult

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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 CalculateBrachy3DDoseResult : SerializableObject, IXmlSerializable

Properties

Errors

Error messages if "Success" is false.

Declaration

public IEnumerable<string> Errors { get; }

Property Value

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

RoundedDwellTimeAdjustRatio

The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false

Declaration

public double RoundedDwellTimeAdjustRatio { get; }

Property Value

Type	Description
System.Double

Success

Was the dose calculation successful?

Declaration

public bool Success { get; }

Property Value

Type	Description
System.Boolean

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

SerializableObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable