ZOS-API interface 2024 R2 SP02

ZOSAPI.Wizards.INSCWizard Interface Reference

Last update: 17.07.2025

Interface for the Common data for the Merit Function, Nonsequential Component Optimization and Bitmap Wizards. More...

Inheritance diagram for ZOSAPI.Wizards.INSCWizard:
Inheritance graph
[legend]

Public Member Functions

string GetSourceAt (int idx)
 
string GetDetectorAt (int idx)
 
string GetCriterionAt (int idx)
 
string GetConfigurationAt (int idx)
 
string GetRaySamplingAt (int idx)
 
string GetEdgeSamplingAt (int idx)
 
string GetBoundaryAt (int idx)
 
- Public Member Functions inherited from ZOSAPI.Wizards.IWizard
void OK ()
 Settings are set, perform the wizardry.
 
void Apply ()
 Settings are set, perform the wizardry.
 
void SaveSettings ()
 Save the Settings.
 
void LoadSettings ()
 Load the Settings.
 
void ResetSettings ()
 Reset the settings.
 
void Initialize ()
 

Properties

bool IsNSCOptimizingWizard [get]
 
bool IsNSCBitmapWizard [get]
 
bool IsClearDataSettingsUsed [get, set]
 
bool IsRaytraceSettingsUsed [get, set]
 
bool IsSplitRaysUsed [get, set]
 
bool IsUsePolarizationUsed [get, set]
 
bool IsScatterRaysUsed [get, set]
 
bool IsIgnoreErrorsUsed [get, set]
 
bool IsUseLightningTraceUsed [get, set]
 
bool IsCriterionSettingsUsed [get, set]
 
bool IsMinimumFluxUsed [get, set]
 
bool IsOverwriteUsed [get, set]
 
bool IsTargetSettingsUsed [get, set]
 
bool IsColorTargetsUsed [get, set]
 
bool IsResampleDetectorUsed [get, set]
 
int ClearDetector [get, set]
 
int Criterion [get, set]
 
int UseSource [get, set]
 
int UseDetector [get, set]
 
int Boundary [get, set]
 
int StartAt [get, set]
 
int Configuration [get, set]
 
int BitmapFile [get, set]
 
int RaySampling [get, set]
 
int EdgeSampling [get, set]
 
double Target [get, set]
 
double MinimumFlux [get, set]
 
double OverallWeight [get, set]
 
double TotalFlux [get, set]
 
int NumberOfSources [get]
 
int NumberOfDetectors [get]
 
int NumberOfCriterion [get]
 
int NumberOfConfigurations [get]
 
int NumberOfRaySamplings [get]
 
int NumberOfEdgeSamplings [get]
 
int NumberOfBoundaries [get]
 
- Properties inherited from ZOSAPI.Wizards.IWizard
WizardType Wizard [get]
 Gets the type of this wizard instance.
 

Detailed Description

Interface for the Common data for the Merit Function, Nonsequential Component Optimization and Bitmap Wizards.

Member Function Documentation

◆ GetBoundaryAt()

string ZOSAPI.Wizards.INSCWizard.GetBoundaryAt ( int  idx)

◆ GetConfigurationAt()

string ZOSAPI.Wizards.INSCWizard.GetConfigurationAt ( int  idx)

◆ GetCriterionAt()

string ZOSAPI.Wizards.INSCWizard.GetCriterionAt ( int  idx)

◆ GetDetectorAt()

string ZOSAPI.Wizards.INSCWizard.GetDetectorAt ( int  idx)

◆ GetEdgeSamplingAt()

string ZOSAPI.Wizards.INSCWizard.GetEdgeSamplingAt ( int  idx)

◆ GetRaySamplingAt()

string ZOSAPI.Wizards.INSCWizard.GetRaySamplingAt ( int  idx)

◆ GetSourceAt()

string ZOSAPI.Wizards.INSCWizard.GetSourceAt ( int  idx)

Property Documentation

◆ BitmapFile

int ZOSAPI.Wizards.INSCWizard.BitmapFile
getset

◆ Boundary

int ZOSAPI.Wizards.INSCWizard.Boundary
getset

◆ ClearDetector

int ZOSAPI.Wizards.INSCWizard.ClearDetector
getset

◆ Configuration

int ZOSAPI.Wizards.INSCWizard.Configuration
getset

◆ Criterion

int ZOSAPI.Wizards.INSCWizard.Criterion
getset

◆ EdgeSampling

int ZOSAPI.Wizards.INSCWizard.EdgeSampling
getset

◆ IsClearDataSettingsUsed

bool ZOSAPI.Wizards.INSCWizard.IsClearDataSettingsUsed
getset

◆ IsColorTargetsUsed

bool ZOSAPI.Wizards.INSCWizard.IsColorTargetsUsed
getset

◆ IsCriterionSettingsUsed

bool ZOSAPI.Wizards.INSCWizard.IsCriterionSettingsUsed
getset

◆ IsIgnoreErrorsUsed

bool ZOSAPI.Wizards.INSCWizard.IsIgnoreErrorsUsed
getset

◆ IsMinimumFluxUsed

bool ZOSAPI.Wizards.INSCWizard.IsMinimumFluxUsed
getset

◆ IsNSCBitmapWizard

bool ZOSAPI.Wizards.INSCWizard.IsNSCBitmapWizard
get

◆ IsNSCOptimizingWizard

bool ZOSAPI.Wizards.INSCWizard.IsNSCOptimizingWizard
get

◆ IsOverwriteUsed

bool ZOSAPI.Wizards.INSCWizard.IsOverwriteUsed
getset

◆ IsRaytraceSettingsUsed

bool ZOSAPI.Wizards.INSCWizard.IsRaytraceSettingsUsed
getset

◆ IsResampleDetectorUsed

bool ZOSAPI.Wizards.INSCWizard.IsResampleDetectorUsed
getset

◆ IsScatterRaysUsed

bool ZOSAPI.Wizards.INSCWizard.IsScatterRaysUsed
getset

◆ IsSplitRaysUsed

bool ZOSAPI.Wizards.INSCWizard.IsSplitRaysUsed
getset

◆ IsTargetSettingsUsed

bool ZOSAPI.Wizards.INSCWizard.IsTargetSettingsUsed
getset

◆ IsUseLightningTraceUsed

bool ZOSAPI.Wizards.INSCWizard.IsUseLightningTraceUsed
getset

◆ IsUsePolarizationUsed

bool ZOSAPI.Wizards.INSCWizard.IsUsePolarizationUsed
getset

◆ MinimumFlux

double ZOSAPI.Wizards.INSCWizard.MinimumFlux
getset

◆ NumberOfBoundaries

int ZOSAPI.Wizards.INSCWizard.NumberOfBoundaries
get

◆ NumberOfConfigurations

int ZOSAPI.Wizards.INSCWizard.NumberOfConfigurations
get

◆ NumberOfCriterion

int ZOSAPI.Wizards.INSCWizard.NumberOfCriterion
get

◆ NumberOfDetectors

int ZOSAPI.Wizards.INSCWizard.NumberOfDetectors
get

◆ NumberOfEdgeSamplings

int ZOSAPI.Wizards.INSCWizard.NumberOfEdgeSamplings
get

◆ NumberOfRaySamplings

int ZOSAPI.Wizards.INSCWizard.NumberOfRaySamplings
get

◆ NumberOfSources

int ZOSAPI.Wizards.INSCWizard.NumberOfSources
get

◆ OverallWeight

double ZOSAPI.Wizards.INSCWizard.OverallWeight
getset

◆ RaySampling

int ZOSAPI.Wizards.INSCWizard.RaySampling
getset

◆ StartAt

int ZOSAPI.Wizards.INSCWizard.StartAt
getset

◆ Target

double ZOSAPI.Wizards.INSCWizard.Target
getset

◆ TotalFlux

double ZOSAPI.Wizards.INSCWizard.TotalFlux
getset

◆ UseDetector

int ZOSAPI.Wizards.INSCWizard.UseDetector
getset

◆ UseSource

int ZOSAPI.Wizards.INSCWizard.UseSource
getset

Connect with Ansys