Class Block
Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam.
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 Block : ApiDataObject
Properties
AddOnMaterial
The dosimetric material of the block.
Declaration
public AddOnMaterial AddOnMaterial { get; }
Property Value
| Type | Description |
|---|---|
| AddOnMaterial |
IsDiverging
Checks if the block cut is diverging.
Declaration
public bool IsDiverging { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Outline
Gets the block outline coordinates in field coordinates.
Declaration
public Point[][] Outline { get; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Point[][] |
TransmissionFactor
The transmission factor of the selected material.
Declaration
public double TransmissionFactor { get; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Tray
The tray on which the block is installed.
Declaration
public Tray Tray { get; }
Property Value
| Type | Description |
|---|---|
| Tray |
TrayTransmissionFactor
The transmission factor of the selected tray.
Declaration
public double TrayTransmissionFactor { get; }
Property Value
| Type | Description |
|---|---|
| System.Double |
Type
The type of the block: shielding or aperture.
Declaration
public BlockType Type { get; }
Property Value
| Type | Description |
|---|---|
| BlockType |
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