Interface ZOSAPI::Analysis::Settings::NSCSpot::IAS_NSCSpot

Definition:

Inherits from:

• ZOSAPI.Analysis.Settings.IAS_

Members

• ColorRaysBy
• Configuration
• DirectionCosines
• GetConfigurationName
• GetFaceAt
• GetFaceNumber
• GetGroupList
• GetGroupName
• GetGroupNameAt
• GetInstanceName
• GetNumberOfAvailableGroups
• GetNumberOfAvailableInstances
• GetNumberOfAvailableObjectFaces
• GetNumberOfAvailableSequences
• GetObjectAt
• GetObjectFaceList
• GetObjectFaceName
• GetObjectFaceNameAt
• GetObjectNumber
• GetSequenceList
• GetSequenceName
• GetSequenceNameAt
• GetWavelengthName
• Group
• Instance
• Load
• LoadFrom
• ModifySettings
• ObjectFace
• Pattern
• PlotScale
• RayDensity
• ReferTo
• Reset
• Save
• SaveTo
• ScatterRays
• Sequence
• SetGroup
• SetObjectFace
• SetSequence
• ShowAiryDisk
• ShowScale
• SplitRays
• UseAllConfigurations
• UseCurrentConfiguration
• UsePolarization
• UseSourceWavelength
• UseSymbols
• Verify
• Wavelength

Properties

Property ShowScale

Definition:

ShowScales ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ShowScale

Return type: ShowScales

Property Pattern

Definition:

Patterns ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Pattern

Return type: Patterns

Property ColorRaysBy

Definition:

ColorRaysBy ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ColorRaysBy

Return type: ColorRaysBy

Property ReferTo

Definition:

Reference ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ReferTo

Return type: Reference

Property UsePolarization

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.UsePolarization

Return type: bool

Property DirectionCosines

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.DirectionCosines

Return type: bool

Property ShowAiryDisk

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ShowAiryDisk

Return type: bool

Property ScatterRays

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ScatterRays

Return type: bool

Property SplitRays

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.SplitRays

Return type: bool

Property PlotScale

Definition:

double ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.PlotScale

Return type: double

Property UseSymbols

Definition:

bool ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.UseSymbols

Return type: bool

Property RayDensity

Definition:

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.RayDensity

Return type: int

Property Wavelength

Definition:

IAS_Wavelength ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Wavelength

Return type: IAS_Wavelength

Property ObjectFace

Definition:

IAS_ObjectFace ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.ObjectFace

Return type: IAS_ObjectFace

Property Group

Definition:

IAS_Group ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Group

Return type: IAS_Group

Property Instance

Definition:

IAS_Instance ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Instance

Return type: IAS_Instance

Property Sequence

Definition:

IAS_Sequence ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Sequence

Return type: IAS_Sequence

Property Configuration

Definition:

IAS_Configuration ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.Configuration

Return type: IAS_Configuration

Public functions

Function SetObjectFace

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.SetObjectFace(int objectNumber, int faceNumber)

Parameters:

• int objectNumber
• int faceNumber

Return type: void

Function GetObjectNumber

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetObjectNumber()

Return type: int

Function GetFaceNumber

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetFaceNumber()

Return type: int

Function SetGroup

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.SetGroup(string name)

Parameters:

• string name

Return type: void

Function SetSequence

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.SetSequence(string name)

Parameters:

• string name

Return type: void

Function UseSourceWavelength

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.UseSourceWavelength()

Return type: void

Function GetWavelengthName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetWavelengthName()

Return type: string

Function GetNumberOfAvailableObjectFaces

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetNumberOfAvailableObjectFaces()

Return type: int

Function GetObjectFaceNameAt

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetObjectFaceNameAt(int index)

Parameters:

• int index

Return type: string

Function GetObjectAt

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetObjectAt(int index)

Parameters:

• int index

Return type: int

Function GetFaceAt

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetFaceAt(int index)

Parameters:

• int index

Return type: int

Function GetObjectFaceList

string[] ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetObjectFaceList()

Return type: string[]

Function GetNumberOfAvailableGroups

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetNumberOfAvailableGroups()

Return type: int

Function GetGroupNameAt

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetGroupNameAt(int index)

Parameters:

• int index

Return type: string

Function GetGroupList

string[] ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetGroupList()

Return type: string[]

Function GetGroupName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetGroupName()

Return type: string

Function GetNumberOfAvailableInstances

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetNumberOfAvailableInstances()

Return type: int

Function GetInstanceName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetInstanceName()

Return type: string

Function GetSequenceList

string[] ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetSequenceList()

Return type: string[]

Function GetSequenceNameAt

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetSequenceNameAt(int index)

Parameters:

• int index

Return type: string

Function GetNumberOfAvailableSequences

int ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetNumberOfAvailableSequences()

Return type: int

Function GetConfigurationName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetConfigurationName()

Return type: string

Function UseAllConfigurations

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.UseAllConfigurations()

Return type: void

Function UseCurrentConfiguration

void ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.UseCurrentConfiguration()

Return type: void

Function GetSequenceName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetSequenceName()

Return type: string

Function GetObjectFaceName

string ZOSAPI.Analysis.Settings.NSCSpot.IAS_NSCSpot.GetObjectFaceName()

Return type: string