Class Catheter

Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a BrachyTreatmentUnit, a ChannelNumber, and possibly a BrachySolidApplicatorPartID of the BrachySolidApplicator they belong to. Most notably, catheters encapsulate the Shape of the applicator channel centerline and its SourcePositions.

Inheritance

System.Object

SerializableObject

ApiDataObject

Catheter

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

Properties

ApplicatorLength

The total length from the tip of the catheter to the treatment unit in millimeters.

Declaration

public double ApplicatorLength { get; set; }

Property Value

Type	Description
System.Double

BrachyFieldReferencePoints

A collection of brachy field reference points.

Declaration

public IEnumerable<BrachyFieldReferencePoint> BrachyFieldReferencePoints { get; }

Property Value

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

BrachySolidApplicatorPartID

The unique identifier of the BrachySolidApplicator part associated with the channel.

Declaration

public int BrachySolidApplicatorPartID { get; }

Property Value

Type	Description
System.Int32

ChannelNumber

The channel number of this catheter.

Declaration

public int ChannelNumber { get; set; }

Property Value

Type	Description
System.Int32

Color

The color of the catheter in 2D views.

Declaration

public Color Color { get; }

Property Value

Type	Description
System.Windows.Media.Color

DeadSpaceLength

The total length from the tip of the catheter to the start of the inner lumen in millimeters.

Declaration

public double DeadSpaceLength { get; set; }

Property Value

Type	Description
System.Double

FirstSourcePosition

The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter.

Declaration

public double FirstSourcePosition { get; }

Property Value

Type	Description
System.Double

GroupNumber

Catheter Group number.

Declaration

public int GroupNumber { get; }

Property Value

Type	Description
System.Int32

LastSourcePosition

The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter.

Declaration

public double LastSourcePosition { get; }

Property Value

Type	Description
System.Double

Shape

The DICOM coordinates of the applicator shape starting from the tip.

Declaration

public VVector[] Shape { get; set; }

Property Value

Type	Description
VVector[]

SourcePositions

The source positions in the catheter starting from the tip.

Declaration

public IEnumerable<SourcePosition> SourcePositions { get; }

Property Value

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

StepSize

The step size of the catheter in millimeters.

Declaration

public double StepSize { get; }

Property Value

Type	Description
System.Double

TreatmentUnit

The brachytherapy treatment unit associated with this catheter.

Declaration

public BrachyTreatmentUnit TreatmentUnit { get; }

Property Value

Type	Description
BrachyTreatmentUnit

Methods

GetSourcePosCenterDistanceFromTip(SourcePosition)

The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation.

Declaration

public double GetSourcePosCenterDistanceFromTip(SourcePosition sourcePosition)

Parameters

Type	Name	Description
SourcePosition	sourcePosition	The source position for which the distance from the catheter tip is got.

Returns

Type	Description
System.Double	The distance from the tip of the catheter to the source position center, in millimeters.

See Also

SourceCenterOffsetFromTip

GetTotalDwellTime()

The total dwell time in this catheter in seconds.

Declaration

public double GetTotalDwellTime()

Returns

Type	Description
System.Double	The total dwell time in this catheter in seconds.

LinkRefLine(Structure)

[Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator.

Declaration

public void LinkRefLine(Structure refLine)

Parameters

Type	Name	Description
Structure	refLine	Reference line to link with applicator.

LinkRefPoint(ReferencePoint)

[Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator.

Declaration

public void LinkRefPoint(ReferencePoint refPoint)

Parameters

Type	Name	Description
ReferencePoint	refPoint	Reference point to link with applicator.

SetId(String, out String)

[Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator.

Declaration

public bool SetId(string id, out string message)

Parameters

Type	Name	Description
System.String	id	The new ID for the applicator.
System.String	message	May be populated with a reason why setting the ID failed.

Returns

Type	Description
System.Boolean	True if the ID was modified.

SetSourcePositions(Double, Double, Double)

[Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter.

Declaration

public SetSourcePositionsResult SetSourcePositions(double stepSize, double firstSourcePosition, double lastSourcePosition)

Parameters

Type	Name	Description
System.Double	stepSize	Step size in millimeters.
System.Double	firstSourcePosition	First source position in millimeters.
System.Double	lastSourcePosition	Last source position in millimeters.

Returns

Type	Description
SetSourcePositionsResult	SetSourcePositionsResult struct, with its Boolean members populated according to effects of the call.

UnlinkRefLine(Structure)

[Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator.

Declaration

public void UnlinkRefLine(Structure refLine)

Parameters

Type	Name	Description
Structure	refLine	Reference line to unlink from applicator

UnlinkRefPoint(ReferencePoint)

[Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator.

Declaration

public void UnlinkRefPoint(ReferencePoint refPoint)

Parameters

Type	Name	Description
ReferencePoint	refPoint	reference point to unlink with applicator

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