Class Course

A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course.

Inheritance

System.Object

SerializableObject

ApiDataObject

Course

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Name

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

Properties

BrachyPlanSetups

A collection of brachytherapy plans for the course.

Declaration

public IEnumerable<BrachyPlanSetup> BrachyPlanSetups { get; }

Property Value

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

ClinicalStatus

Clinical Status of Course.

Declaration

public CourseClinicalStatus ClinicalStatus { get; }

Property Value

Type	Description
CourseClinicalStatus

Comment

[Availability of this property depends on your Eclipse Scripting API license] A comment about the Course.

Declaration

public string Comment { get; set; }

Property Value

Type	Description
System.String

CompletedDateTime

The date and time when the course was completed.

Declaration

public DateTime? CompletedDateTime { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

Diagnoses

The diagnoses that are attached to the course.

Declaration

public IEnumerable<Diagnosis> Diagnoses { get; }

Property Value

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

ExternalPlanSetups

A collection of external beam plans for the course.

Declaration

public IEnumerable<ExternalPlanSetup> ExternalPlanSetups { get; }

Property Value

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

Id

[Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Intent

The intent of the course.

Declaration

public string Intent { get; }

Property Value

Type	Description
System.String

IonPlanSetups

A collection of proton plans for the course.

Declaration

public IEnumerable<IonPlanSetup> IonPlanSetups { get; }

Property Value

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

Patient

Patient in which the course is defined.

Declaration

public Patient Patient { get; }

Property Value

Type	Description
Patient

PlanSetups

A collection of plans for the course. The plans can be of any type (external beam or brachytherapy).

Declaration

public IEnumerable<PlanSetup> PlanSetups { get; }

Property Value

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

PlanSums

A collection of plan sums for the course.

Declaration

public IEnumerable<PlanSum> PlanSums { get; }

Property Value

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

StartDateTime

The date and time when the course was started.

Declaration

public DateTime? StartDateTime { get; }

Property Value

Type	Description
System.Nullable<System.DateTime>

TreatmentPhases

All treatment phases in the course.

Declaration

public IEnumerable<TreatmentPhase> TreatmentPhases { get; }

Property Value

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

TreatmentSessions

Treatment sessions of the course.

Declaration

public IEnumerable<TreatmentSession> TreatmentSessions { get; }

Property Value

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

Methods

AddBrachyPlanSetup(StructureSet, Structure, ReferencePoint, DoseValue, BrachyTreatmentTechniqueType)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure and primary reference point specified in arguments.

Declaration

public BrachyPlanSetup AddBrachyPlanSetup(StructureSet structureSet, Structure targetStructure, ReferencePoint primaryReferencePoint, DoseValue dosePerFraction, BrachyTreatmentTechniqueType brachyTreatmentTechnique)

Parameters

Type	Name	Description
StructureSet	structureSet	Valid StructureSet to be connected to the plan
Structure	targetStructure	Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset.
ReferencePoint	primaryReferencePoint	Valid reference point to be connected as primary reference point.
DoseValue	dosePerFraction	Dose per fraction
BrachyTreatmentTechniqueType	brachyTreatmentTechnique	Brachytherapy treatment technique

Returns

Type	Description
BrachyPlanSetup	New brachytherapy plan with primary reference point and target structure set as specified in arguments.

AddBrachyPlanSetup(StructureSet, DoseValue, BrachyTreatmentTechniqueType)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan.

Declaration

public BrachyPlanSetup AddBrachyPlanSetup(StructureSet structureSet, DoseValue dosePerFraction, BrachyTreatmentTechniqueType brachyTreatmentTechnique)

Parameters

Type	Name	Description
StructureSet	structureSet	A valid StructureSet to be connected to the plan.
DoseValue	dosePerFraction	Dose per fraction
BrachyTreatmentTechniqueType	brachyTreatmentTechnique	Brachytherapy treatment technique

Returns

Type	Description
BrachyPlanSetup	A new brachytherapy plan.

AddExternalPlanSetup(StructureSet)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan.

Declaration

public ExternalPlanSetup AddExternalPlanSetup(StructureSet structureSet)

Parameters

Type	Name	Description
StructureSet	structureSet	A valid structure set.

Returns

Type	Description
ExternalPlanSetup	A new plan.

AddExternalPlanSetup(StructureSet, Structure, ReferencePoint)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target and primary reference point in arguments

Declaration

public ExternalPlanSetup AddExternalPlanSetup(StructureSet structureSet, Structure targetStructure, ReferencePoint primaryReferencePoint)

Parameters

Type	Name	Description
StructureSet	structureSet	Valid StructureSet to connected with the plan
Structure	targetStructure	Target structure, if defined must be from 'structureSet', if left null target will remain unset.
ReferencePoint	primaryReferencePoint	Valid reference point to be connected as primary.

Returns

Type	Description
ExternalPlanSetup	New external beam plan with primary reference point and target structure set as specified in arguments.

AddExternalPlanSetupAsVerificationPlan(StructureSet, ExternalPlanSetup)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan.

Declaration

public ExternalPlanSetup AddExternalPlanSetupAsVerificationPlan(StructureSet structureSet, ExternalPlanSetup verifiedPlan)

Parameters

Type	Name	Description
StructureSet	structureSet	A valid structure set.
ExternalPlanSetup	verifiedPlan	The verified plan.

Returns

Type	Description
ExternalPlanSetup	A new verification plan.

AddIonPlanSetup(StructureSet, String)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course.

Declaration

public IonPlanSetup AddIonPlanSetup(StructureSet structureSet, string patientSupportDeviceId)

Parameters

Type	Name	Description
StructureSet	structureSet	A valid structure set.
System.String	patientSupportDeviceId	Id of the patient support device.

Returns

Type	Description
IonPlanSetup	A new proton plan.

AddIonPlanSetupAsVerificationPlan(StructureSet, String, IonPlanSetup)

[Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan.

Declaration

public IonPlanSetup AddIonPlanSetupAsVerificationPlan(StructureSet structureSet, string patientSupportDeviceId, IonPlanSetup verifiedPlan)

Parameters

Type	Name	Description
StructureSet	structureSet	A valid structure set.
System.String	patientSupportDeviceId	Id of the patient support device.
IonPlanSetup	verifiedPlan	The verified plan.

Returns

Type	Description
IonPlanSetup	A new proton verification plan.

CanAddPlanSetup(StructureSet)

Checks if a new plan can be added to this course using the given structure set.

Declaration

public bool CanAddPlanSetup(StructureSet structureSet)

Parameters

Type	Name	Description
StructureSet	structureSet	The structure set used by the plan.

Returns

Type	Description
System.Boolean	true if a new plan can be added.

CanRemovePlanSetup(PlanSetup)

Checks if the plan setup can be removed from this course.

Declaration

public bool CanRemovePlanSetup(PlanSetup planSetup)

Parameters

Type	Name	Description
PlanSetup	planSetup	The plan setup to check.

Returns

Type	Description
System.Boolean	true if the plan can be removed.

CopyBrachyPlanSetup(BrachyPlanSetup, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans).

Declaration

public BrachyPlanSetup CopyBrachyPlanSetup(BrachyPlanSetup sourcePlan, StringBuilder outputDiagnostics)

Parameters

Type	Name	Description
BrachyPlanSetup	sourcePlan	Brachy plan to copy from
System.Text.StringBuilder	outputDiagnostics	Information about copying, this needs to be shown to the user.

Returns

Type	Description
BrachyPlanSetup	New plan

CopyBrachyPlanSetup(BrachyPlanSetup, StructureSet, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image.

Declaration

public BrachyPlanSetup CopyBrachyPlanSetup(BrachyPlanSetup sourcePlan, StructureSet structureset, StringBuilder outputDiagnostics)

Parameters

Type	Name	Description
BrachyPlanSetup	sourcePlan	Brachy plan to copy from
StructureSet	structureset	The structure set along with its associated image that will be assigned to the copied plan
System.Text.StringBuilder	outputDiagnostics	Information about copying, this needs to be shown to the user.

Returns

Type	Description
BrachyPlanSetup	New plan

CopyPlanSetup(PlanSetup)

[Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans).

Declaration

public PlanSetup CopyPlanSetup(PlanSetup sourcePlan)

Parameters

Type	Name	Description
PlanSetup	sourcePlan	Plan to copy from

Returns

Type	Description
PlanSetup	New plan

CopyPlanSetup(PlanSetup, Image, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this.

Declaration

public PlanSetup CopyPlanSetup(PlanSetup sourcePlan, Image targetImage, StringBuilder outputDiagnostics)

Parameters

Type	Name	Description
PlanSetup	sourcePlan	Plan to copy from
Image	targetImage	Image to copy plan to
System.Text.StringBuilder	outputDiagnostics	Information about copying, this needs to be shown to the user.

Returns

Type	Description
PlanSetup	New plan

CopyPlanSetup(PlanSetup, Image, Registration, StringBuilder)

Declaration

public PlanSetup CopyPlanSetup(PlanSetup sourcePlan, Image targetImage, Registration registration, StringBuilder outputDiagnostics)

Parameters

Type	Name	Description
PlanSetup	sourcePlan	Plan to copy from
Image	targetImage	Image to copy plan to
Registration	registration	Registration to use to map geometry from source to target
System.Text.StringBuilder	outputDiagnostics	Information about copying, this needs to be shown to the user.

Returns

Type	Description
PlanSetup	New plan

CopyPlanSetup(PlanSetup, StructureSet, StringBuilder)

[Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image.

Declaration

public PlanSetup CopyPlanSetup(PlanSetup sourcePlan, StructureSet structureset, StringBuilder outputDiagnostics)

Parameters

Type	Name	Description
PlanSetup	sourcePlan	Plan to copy from
StructureSet	structureset	The structure set along with its associated image that will be assigned to the copied plan
System.Text.StringBuilder	outputDiagnostics	Information about copying, this needs to be shown to the user.

Returns

Type	Description
PlanSetup	New plan

CreatePlanSum(IEnumerable<PlanningItem>, Image)

[Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items.

Declaration

public PlanSum CreatePlanSum(IEnumerable<PlanningItem> planningItems, Image image)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PlanningItem>	planningItems	Items to create sum from. All plans must share the same image, otherwise please use CopyPlanSetup(PlanSetup, Image, Registration, StringBuilder) method before adding plan to Plan sum.
Image	image	Plan Sum image

Returns

Type	Description
PlanSum	Plan sum if creation was possible.

IsCompleted()

Checks if the clinical status of the course is completed or restored.

Declaration

public bool IsCompleted()

Returns

Type	Description
System.Boolean	true if the clinical status of the course is completed or restored.

RemovePlanSetup(PlanSetup)

[Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use CanRemovePlanSetup(PlanSetup) to check if it is possible to remove the plan. The PlanSetup object given as a parameter is not usable anymore after this operation.

Declaration

public void RemovePlanSetup(PlanSetup planSetup)

Parameters

Type	Name	Description
PlanSetup	planSetup	The plan setup that is removed.

RemovePlanSum(PlanSum)

[Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation.

Declaration

public void RemovePlanSum(PlanSum planSum)

Parameters

Type	Name	Description
PlanSum	planSum	The plan sum that is removed.

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