Class TradeoffExplorationContext

Inheritance

System.Object

TradeoffExplorationContext

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:ESAPIX.Facade.API

Assembly:cs.temp.dll.dll

Syntax

public class TradeoffExplorationContext

Constructors

TradeoffExplorationContext()

Declaration

public TradeoffExplorationContext()

TradeoffExplorationContext(Object)

Declaration

public TradeoffExplorationContext(dynamic client)

Parameters

Type	Name	Description
System.Object	client

Properties

CanCreatePlanCollection

Declaration

public bool CanCreatePlanCollection { get; set; }

Property Value

Type	Description
System.Boolean

CanLoadSavedPlanCollection

Declaration

public bool CanLoadSavedPlanCollection { get; set; }

Property Value

Type	Description
System.Boolean

CanUsePlanDoseAsIntermediateDose

Declaration

public bool CanUsePlanDoseAsIntermediateDose { get; set; }

Property Value

Type	Description
System.Boolean

CurrentDose

Declaration

public Dose CurrentDose { get; set; }

Property Value

Type	Description
Dose

HasPlanCollection

Declaration

public bool HasPlanCollection { get; set; }

Property Value

Type	Description
System.Boolean

IsLive

Declaration

public bool IsLive { get; }

Property Value

Type	Description
System.Boolean

TargetStructures

Declaration

public IReadOnlyList<Structure> TargetStructures { get; set; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<Structure>

TradeoffObjectiveCandidates

Declaration

public IReadOnlyList<OptimizationObjective> TradeoffObjectiveCandidates { get; set; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<OptimizationObjective>

TradeoffObjectives

Declaration

public IReadOnlyCollection<TradeoffObjective> TradeoffObjectives { get; set; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<TradeoffObjective>

TradeoffStructureCandidates

Declaration

public IReadOnlyList<Structure> TradeoffStructureCandidates { get; set; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<Structure>

Methods

AddTargetHomogeneityObjective(Structure)

Declaration

public bool AddTargetHomogeneityObjective(Structure targetStructure)

Parameters

Type	Name	Description
Structure	targetStructure

Returns

Type	Description
System.Boolean

AddTradeoffObjective(OptimizationObjective)

Declaration

public bool AddTradeoffObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

Returns

Type	Description
System.Boolean

AddTradeoffObjective(Structure)

Declaration

public bool AddTradeoffObjective(Structure structure)

Parameters

Type	Name	Description
Structure	structure

Returns

Type	Description
System.Boolean

ApplyTradeoffExplorationResult()

Declaration

public void ApplyTradeoffExplorationResult()

CreateDeliverableVmatPlan(Boolean)

Declaration

public bool CreateDeliverableVmatPlan(bool useIntermediateDose)

Parameters

Type	Name	Description
System.Boolean	useIntermediateDose

Returns

Type	Description
System.Boolean

CreatePlanCollection(Boolean, Object)

Declaration

public bool CreatePlanCollection(bool continueOptimization, dynamic intermediateDoseMode)

Parameters

Type	Name	Description
System.Boolean	continueOptimization
System.Object	intermediateDoseMode

Returns

Type	Description
System.Boolean

GetObjectiveCost(TradeoffObjective)

Declaration

public double GetObjectiveCost(TradeoffObjective objective)

Parameters

Type	Name	Description
TradeoffObjective	objective

Returns

Type	Description
System.Double

GetObjectiveLowerLimit(TradeoffObjective)

Declaration

public double GetObjectiveLowerLimit(TradeoffObjective objective)

Parameters

Type	Name	Description
TradeoffObjective	objective

Returns

Type	Description
System.Double

GetObjectiveUpperLimit(TradeoffObjective)

Declaration

public double GetObjectiveUpperLimit(TradeoffObjective objective)

Parameters

Type	Name	Description
TradeoffObjective	objective

Returns

Type	Description
System.Double

GetObjectiveUpperRestrictor(TradeoffObjective)

Declaration

public double GetObjectiveUpperRestrictor(TradeoffObjective objective)

Parameters

Type	Name	Description
TradeoffObjective	objective

Returns

Type	Description
System.Double

GetStructureDvh(Structure)

Declaration

public DVHData GetStructureDvh(Structure structure)

Parameters

Type	Name	Description
Structure	structure

Returns

Type	Description
DVHData

LoadSavedPlanCollection()

Declaration

public bool LoadSavedPlanCollection()

Returns

Type	Description
System.Boolean

RemoveAllTradeoffObjectives()

Declaration

public void RemoveAllTradeoffObjectives()

RemovePlanCollection()

Declaration

public void RemovePlanCollection()

RemoveTargetHomogeneityObjective(Structure)

Declaration

public bool RemoveTargetHomogeneityObjective(Structure targetStructure)

Parameters

Type	Name	Description
Structure	targetStructure

Returns

Type	Description
System.Boolean

RemoveTradeoffObjective(Structure)

Declaration

public bool RemoveTradeoffObjective(Structure structure)

Parameters

Type	Name	Description
Structure	structure

Returns

Type	Description
System.Boolean

RemoveTradeoffObjective(TradeoffObjective)

Declaration

public bool RemoveTradeoffObjective(TradeoffObjective tradeoffObjective)

Parameters

Type	Name	Description
TradeoffObjective	tradeoffObjective

Returns

Type	Description
System.Boolean

ResetToBalancedPlan()

Declaration

public void ResetToBalancedPlan()

SetObjectiveCost(TradeoffObjective, Double)

Declaration

public void SetObjectiveCost(TradeoffObjective tradeoffObjective, double cost)

Parameters

Type	Name	Description
TradeoffObjective	tradeoffObjective
System.Double	cost

SetObjectiveUpperRestrictor(TradeoffObjective, Double)

Declaration

public void SetObjectiveUpperRestrictor(TradeoffObjective tradeoffObjective, double restrictorValue)

Parameters

Type	Name	Description
TradeoffObjective	tradeoffObjective
System.Double	restrictorValue