Class BrachySolidApplicator

Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the Catheter that are part of the solid applicator.

Inheritance
System.Object
SerializableObject
ApiDataObject
BrachySolidApplicator
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 BrachySolidApplicator : ApiDataObject, IXmlSerializable

Properties

ApplicatorSetName

The name of the solid applicator set to which this part belongs.

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

ApplicatorSetType

The type of the solid applicator set to which this part belongs.

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

Category

The category of the solid applicator set to which this part belongs.

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

Catheters

The channel(s) of this solid applicator part.

Declaration
public IEnumerable<Catheter> Catheters { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Catheter>

GroupNumber

Applicator Group number.

Declaration
public int GroupNumber { get; }
Property Value
Type Description
System.Int32

Note

A note or short description of the solid applicator part.

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

PartName

The name of the solid applicator part.

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

PartNumber

The part number of the solid applicator.

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

Summary

A summary of the solid applicator set to which this part belongs.

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

UID

The unique identifier of the solid applicator part.

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

Vendor

The vendor of the solid applicator set to which this part belongs.

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

Version

The version of the solid applicator part.

Declaration
public string Version { 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

Implements

System.Xml.Serialization.IXmlSerializable