Interface IScriptContext
The common interface for use in standalone and plugin applications. It exposes properties that found in a the
"ScriptContext" class
Namespace:ESAPIX.Interfaces
Assembly:cs.temp.dll.dll
Syntax
public interface IScriptContext
Properties
ApplicationName
Declaration
string ApplicationName { get; }
Property Value
| Type |
Description |
| System.String |
|
BrachyPlanSetup
Declaration
BrachyPlanSetup BrachyPlanSetup { get; }
Property Value
| Type |
Description |
| BrachyPlanSetup |
|
BrachyPlansInScope
Declaration
IEnumerable<BrachyPlanSetup> BrachyPlansInScope { get; }
Property Value
| Type |
Description |
| IEnumerable<BrachyPlanSetup> |
|
Course
Declaration
Property Value
CurrentUser
Declaration
User CurrentUser { get; }
Property Value
ExternalPlanSetup
Declaration
ExternalPlanSetup ExternalPlanSetup { get; }
Property Value
| Type |
Description |
| ExternalPlanSetup |
|
ExternalPlansInScope
Declaration
IEnumerable<ExternalPlanSetup> ExternalPlansInScope { get; }
Property Value
| Type |
Description |
| IEnumerable<ExternalPlanSetup> |
|
Image
Declaration
Property Value
Logger
Declaration
Property Value
Patient
Declaration
Property Value
PlanSetup
Declaration
PlanSetup PlanSetup { get; }
Property Value
| Type |
Description |
| PlanSetup |
|
PlansInScope
Declaration
IEnumerable<PlanSetup> PlansInScope { get; }
Property Value
| Type |
Description |
| IEnumerable<PlanSetup> |
|
PlanSumsInScope
Declaration
IEnumerable<PlanSum> PlanSumsInScope { get; }
Property Value
| Type |
Description |
| IEnumerable<PlanSum> |
|
StructureSet
Declaration
StructureSet StructureSet { get; }
Property Value
| Type |
Description |
| StructureSet |
|
Thread
The thread that can access VMS objects
Declaration
IVMSThread Thread { get; }
Property Value
UIDispatcher
Declaration
Dispatcher UIDispatcher { get; set; }
Property Value
| Type |
Description |
| Dispatcher |
|
Methods
GetValue<T>(Func<IScriptContext, T>)
Gets a value on the correct thread and returns it
Declaration
T GetValue<T>(Func<IScriptContext, T> toExecute)
Parameters
| Type |
Name |
Description |
| System.Func<IScriptContext, T> |
toExecute |
the function that assigns the value
|
Returns
| Type |
Description |
| T |
the value requested
|
Type Parameters
| Name |
Description |
| T |
the type of value to be returned
|
GetValueAsync<T>(Func<IScriptContext, T>)
Gets a value asynchronously on the correct thread and returns it
Declaration
Task<T> GetValueAsync<T>(Func<IScriptContext, T> toExecute)
Parameters
| Type |
Name |
Description |
| System.Func<IScriptContext, T> |
toExecute |
the function that assigns the value
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task<T> |
a task of the value requested
|
Type Parameters
| Name |
Description |
| T |
the type of value to be returned
|
Events
BrachyPlanSetupChanged
Declaration
event BrachyPlanSetupChangedHandler BrachyPlanSetupChanged
Event Type
| Type |
Description |
| BrachyPlanSetupChangedHandler |
|
CourseChanged
Declaration
event CourseChangedHandler CourseChanged
Event Type
| Type |
Description |
| CourseChangedHandler |
|
ExternalPlanSetupChanged
Declaration
event ExternalPlanSetupChangedHandler ExternalPlanSetupChanged
Event Type
| Type |
Description |
| ExternalPlanSetupChangedHandler |
|
PatientChanged
Declaration
event PatientChangedHandler PatientChanged
Event Type
| Type |
Description |
| PatientChangedHandler |
|
PlanSetupChanged
Declaration
event PlanSetupChangedHandler PlanSetupChanged
Event Type
| Type |
Description |
| PlanSetupChangedHandler |
|