Class ScriptContext

Contains the runtime context information of the active application for the script.

Inheritance

System.Object

ScriptContext

Inherited Members

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 sealed class ScriptContext

Constructors

ScriptContext(Object, Object, Object, String)

Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context.

Declaration

public ScriptContext(object context, object user, object dvhEstimation, string appName)

Parameters

Type	Name	Description
System.Object	context	The internal data context.
System.Object	user	The internal user object.
System.Object	dvhEstimation	The internal dvh estimation model library object.
System.String	appName	The application name.

Properties

ApplicationName

The name of the active application.

Declaration

public string ApplicationName { get; }

Property Value

Type	Description
System.String

BrachyPlanSetup

The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup.

Declaration

public BrachyPlanSetup BrachyPlanSetup { get; }

Property Value

Type	Description
BrachyPlanSetup

BrachyPlansInScope

Retrieves a list of all brachytherapy plans in the Scope window.

Declaration

public IEnumerable<BrachyPlanSetup> BrachyPlansInScope { get; }

Property Value

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

Calculation

Calculation related functions

Declaration

public Calculation Calculation { get; }

Property Value

Type	Description
Calculation

Course

The course. The value may be null if the context has no course.

Declaration

public Course Course { get; }

Property Value

Type	Description
Course

CurrentUser

The current user of the application.

Declaration

public User CurrentUser { get; }

Property Value

Type	Description
User

ExternalPlanSetup

The active external beam plan setup. The value is null if the active object is not an external beam plan setup.

Declaration

public ExternalPlanSetup ExternalPlanSetup { get; }

Property Value

Type	Description
ExternalPlanSetup

ExternalPlansInScope

Retrieves a list of all external beam plans in the Scope window.

Declaration

public IEnumerable<ExternalPlanSetup> ExternalPlansInScope { get; }

Property Value

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

Image

The 3D image. The value may be null if the context has no image.

Declaration

public Image Image { get; }

Property Value

Type	Description
Image

IonPlanSetup

The active proton plan setup. The value is null if the active object is not a proton plan setup.

Declaration

public IonPlanSetup IonPlanSetup { get; }

Property Value

Type	Description
IonPlanSetup

IonPlansInScope

Retrieves a list of all proton plans in the Scope window.

Declaration

public IEnumerable<IonPlanSetup> IonPlansInScope { get; }

Property Value

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

Patient

The patient. The value may be null if the context has no patient.

Declaration

public Patient Patient { get; }

Property Value

Type	Description
Patient

PlanSetup

The plan setup. The value may be null if the context has no plan setup.

Declaration

public PlanSetup PlanSetup { get; }

Property Value

Type	Description
PlanSetup

PlansInScope

Retrieves a list of all plans in the Scope window.

Declaration

public IEnumerable<PlanSetup> PlansInScope { get; }

Property Value

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

PlanSum

Retrieves the active plan sum.

Declaration

public PlanSum PlanSum { get; }

Property Value

Type	Description
PlanSum

PlanSumsInScope

Retrieves a list of all plan sums in the Scope window.

Declaration

public IEnumerable<PlanSum> PlanSumsInScope { get; }

Property Value

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

StructureCodes

Provides access to the structure code dictionaries with the active structure codes.

Declaration

public ActiveStructureCodeDictionaries StructureCodes { get; set; }

Property Value

Type	Description
ActiveStructureCodeDictionaries

StructureSet

The structure set. The value may be null if the context has no structure set.

Declaration

public StructureSet StructureSet { get; }

Property Value

Type	Description
StructureSet

VersionInfo

The version number of Eclipse.

Declaration

public string VersionInfo { get; }

Property Value

Type	Description
System.String