This is the initial interface to Optic Studio. All applications that wish to use the ZOS-API must first establish a connection, using the T:ZOSAPI.ZOSAPI_Connection class. More...

Inheritance diagram for ZOSAPI.IZOSAPI_Connection:

[legend]

Public Member Functions
IZOSAPI_Application	ConnectToApplication ()
	Attempts to connect to Optic Studio. This will only succeed when the client application was launched by Optic Studio.

IZOSAPI_Application	CreateNewApplication ()
	Attempts to launch a new instance of Optic Studio in 'headless' mode. Note that although the Optic Studio window will not be visible, it still requires an active license.

IZOSAPI_Application	CreateZemaxServer (string applicationName)
	For internal use only.

IZOSAPI_Application	CreateZemaxServerEx (string applicationName, string libraryPath)

IZOSAPI_Application	ConnectAsExtension (int zemaxInstance)
	Connects to an existing instance of OpticStudio in extension mode.

string	RunCommand (string command)
	For internal debugging purposes only.

string	GetConfigSetting (string setting)

void	SetConfigSetting (string setting, string Value)

void	SetCreoInstallPath (string path)

Properties
bool	IsAlive `[get]`
	Gets a value indicating whether ZOS-API connection is still active.

string	InitializationSettings `[get, set]`
	For internal use only.

int[]	IntializationProgress `[get]`
	The initialization progress can be used to help debug any initial connection problems; only applicable when using CreateNewApplication.

double	ConnectionTimeoutSeconds `[get, set]`
	Gets or sets the connection timeout (seconds). This is only used when launching a new OpticStudio instance, with CreateNewApplication.

string	FormattingCulture `[get, set]`
	Gets or sets the culture used when converting numeric values to/from strings. Note that this must be set before calling CreateNewApplication, and has no effect when connecting to an existing instance of OpticStudio.

string	PreferencesFile `[get, set]`
	For standalone ZOS-API applications, this controls the file that will be used to specify all OpticStudio Preferences settings. If no file is specified, all settings will be loaded from the OpticStudio.CFG preferences file, however any changes will not be persisted between sessions.

Detailed Description

This is the initial interface to Optic Studio. All applications that wish to use the ZOS-API must first establish a connection, using the T:ZOSAPI.ZOSAPI_Connection class.

Member Function Documentation

◆ ConnectAsExtension()

IZOSAPI_Application ZOSAPI.IZOSAPI_Connection.ConnectAsExtension ( int zemaxInstance )

Connects to an existing instance of OpticStudio in extension mode.

Parameters

zemaxInstance The OpticStudio instance number to connect to (0 to connect to any available instance).

Returns

IZOSAPI_Application ZOSAPI.IZOSAPI_Connection.CreateZemaxServerEx	(	string	applicationName,
		string	libraryPath
	)

void ZOSAPI.IZOSAPI_Connection.SetConfigSetting	(	string	setting,
		string	Value
	)

ZOSAPI.IZOSAPI_Connection Interface Reference

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ConnectAsExtension()

◆ ConnectToApplication()

◆ CreateNewApplication()

◆ CreateZemaxServer()

◆ CreateZemaxServerEx()

◆ GetConfigSetting()

◆ RunCommand()

◆ SetConfigSetting()

◆ SetCreoInstallPath()

Property Documentation

◆ ConnectionTimeoutSeconds

◆ FormattingCulture

◆ InitializationSettings

◆ IntializationProgress

◆ IsAlive

◆ PreferencesFile

Connect with Ansys