## On this page # Example 15 - C++ Last update: 17.07.2025 # C++ // CppStandaloneApplication.cpp : Defines the entry point for the console application. \#include "stdafx.h" \#include <stdlib.h> \#include <stdio.h> \#include <iostream> \#include <string> \#include <ctime> \#include <functional> \#include <assert.h> // removes warning for using getenv function \#pragma warning(disable:4996) // Note - .tlh files will be generated from the .tlb files (above) once the project is compiled. // Visual Studio will incorrectly continue to report IntelliSense error messages however until it is restarted. \#include "zosapi.h" using namespace std; using namespace [ZOSAPI](namespace_z_o_s_a_p_i.xhtml); using namespace ZOSAPI_Interfaces; void handleError(std::string msg); void logInfo(std::string msg); void finishStandaloneApplication(IZOSAPI_ApplicationPtr TheApplication); int RunApplication() { \#if !\_WIN64 int msgboxID = MessageBox( NULL, (LPCWSTR)L"This example needs to be run as a x64 configuration. Wizards are not supported via COM in 32-bit mode.", (LPCWSTR)L"ZOS-API Error", MB_ICONERROR | MB_OK ); return 0; \#endif CoInitialize(NULL); // Create the initial connection class IZOSAPI_ConnectionPtr TheConnection(__uuidof([ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml))); // Attempt to create a Standalone connection IZOSAPI_ApplicationPtr TheApplication = TheConnection->CreateNewApplication(); if (TheApplication == nullptr) { handleError("An unknown error occurred!"); return -1; } // Check the connection status if (!TheApplication->IsValidLicenseForAPI) { handleError("License check failed!"); return -1; } if (TheApplication->Mode != ZOSAPI_Mode::ZOSAPI_Mode_Server) { handleError("Standlone application was started in the incorrect mode!"); return -1; } IOpticalSystemPtr TheSystem = TheApplication->PrimarySystem; // creates a new API directory CreateDirectory(_bstr_t(TheApplication->SamplesDir + "\\\\API"), NULL); CreateDirectory(_bstr_t(TheApplication->SamplesDir + "\\\\API\\\\CPP"), NULL); // Load a double gauss design sample file TheSystem->LoadFile(_bstr_t(TheApplication->SamplesDir + "\\\\Short course\\\\Optical System Design Using OpticStudio\\\\sc\_dbga1.zos"), false); cout << "Double Gauss Design:" << endl; // Define path locations _bstr_t SamplesFolder = TheApplication->SamplesDir; _bstr_t SampleFile = TheApplication->SamplesDir + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization\\\\OptimizedFile.zos"; CreateDirectory(_bstr_t(TheApplication->SamplesDir + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization"), NULL); TheSystem->SaveAs(SampleFile); // Define System Explorer // Define Aperture ISystemDataPtr SystExplorer = TheSystem->SystemData; SystExplorer->Aperture->ApertureType = ZemaxApertureType::ZemaxApertureType_EntrancePupilDiameter; SystExplorer->Aperture->ApertureValue = 20; // Add 3 fields IFieldPtr Field_1 = SystExplorer->Fields->GetField(1); IFieldPtr NewField_2 = SystExplorer->Fields->AddField(0, 5.0, 1.0); SystExplorer->Fields->SetFieldType(FieldType::FieldType_ParaxialImageHeight); SystExplorer->Fields->MakeEqualAreaFields(3, 21.6); // Add 3 wavelengths: F, d, C bool slPreset = SystExplorer->Wavelengths->SelectWavelengthPreset(WavelengthPreset::WavelengthPreset_FdC_Visible); // Open a shaded model IA_Ptr analysis = TheSystem->Analyses->New_Analysis(AnalysisIDM::AnalysisIDM_ShadedModel); analysis->Terminate(); analysis->WaitForCompletion(); IAS_Ptr settings = analysis->GetSettings(); //need to use - #pragma warning(disable:4996) char* pUserprofile = getenv("Temp"); _bstr_t cfgFile = _bstr_t(pUserprofile) + "\\\\sha.cfg"; // Save the current settings to the temp file settings->SaveTo(cfgFile); // make your modifications to it // MODIFYSETTINGS are defined in the ZPL help files : The Programming Tab > About the ZPL > Keywords settings->ModifySettings(cfgFile, "SHA\_ROTX", "90"); settings->ModifySettings(cfgFile, "SHA\_ROTY", "0"); settings->ModifySettings(cfgFile, "SHA\_ROTZ", "0"); // now load in the modified settings settings->LoadFrom(cfgFile); // If you want to overwrite your default CFG, copy it after you are done modifying the settings : //\_bstr\_t CFG\_fullname = \_bstr\_t(getenv("USERPROFILE")) + "\\\\Documents\\\\Zemax\\\\Configs\\\\POP.CFG"; // copyfile(cfgFile, CFG\_fullname) // generic psuedo code // We don't need the temp file any more, so delete it std::remove(cfgFile); // Run the analysis with the new settings analysis->ApplyAndWaitForCompletion(); // remove all variables and add a F# solve on last surface radius ILensDataEditorPtr TheLDE = TheSystem->LDE; //IOpticalSystemTools IOpticalSystemToolsPtr tools = TheSystem->Tools; tools->RemoveAllVariables(); ILDERowPtr Surface_Last = TheLDE->GetSurfaceAt(TheLDE->NumberOfSurfaces - 2); ISolveDataPtr Solver = Surface_Last->RadiusCell->CreateSolveType(SolveType::SolveType_FNumber); Solver->_S_FNumber->FNumber = 3.1415; Surface_Last->RadiusCell->SetSolveData(Solver); SampleFile = _bstr_t(TheApplication->SamplesDir) + "\\\\API\\\\\\Seq\_Optimization\\\\\\OptimizedFile1.zos"; TheSystem->SaveAs(SampleFile); // change BFL & run quick focus Surface_Last->Thickness = 40.0; IQuickFocusPtr QFocus = tools->OpenQuickFocus(); QFocus->Criterion = QuickFocusCriterion::QuickFocusCriterion_SpotSizeRadial; QFocus->UseCentroid = true; ISystemToolPtr baseTool = QFocus; baseTool->RunAndWaitForCompletion(); baseTool->Close(); SampleFile = _bstr_t(TheApplication->SamplesDir) + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization\\\\OptimizedFile2.zos"; TheSystem->SaveAs(SampleFile); // setup a few variables tools->SetAllRadiiVariable(); ILDERowPtr [Surface1](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml#a18ffc5c5c02195e015067483e4439229a6c4ed555a70d463f08be6c7dd75270ba) = TheLDE->GetSurfaceAt(1); ILDERowPtr [Surface2](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml#a18ffc5c5c02195e015067483e4439229a50ba23165f586b14ed916c6119b06129) = TheLDE->GetSurfaceAt(2); ILDERowPtr Surface5 = TheLDE->GetSurfaceAt(5); ILDERowPtr Surface6 = TheLDE->GetSurfaceAt(6); ILDERowPtr Surface9 = TheLDE->GetSurfaceAt(9); ILDERowPtr Surface10 = TheLDE->GetSurfaceAt(10); ILDERowPtr Surface11 = TheLDE->GetSurfaceAt(11); // Thickness 2, 5, 6, 9, and 11 variable [Surface2](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml#a18ffc5c5c02195e015067483e4439229a50ba23165f586b14ed916c6119b06129)->ThicknessCell->MakeSolveVariable(); Surface5->ThicknessCell->MakeSolveVariable(); Surface6->ThicknessCell->MakeSolveVariable(); Surface9->ThicknessCell->MakeSolveVariable(); Surface11->ThicknessCell->MakeSolveVariable(); // Thickness 10 pick up from 1 Solver = Surface10->ThicknessCell->CreateSolveType(SolveType::SolveType_SurfacePickup); ISolveSurfacePickupPtr SolverPickup = Solver->_S_SurfacePickup; SolverPickup->Surface = 1; SolverPickup->ScaleFactor = 1; SolverPickup->Column = SurfaceColumn::SurfaceColumn_Thickness; Surface10->ThicknessCell->SetSolveData(Solver); SampleFile = _bstr_t(TheApplication->SamplesDir + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization\\\\OptimizedFile3.zos"); TheSystem->SaveAs(SampleFile); // define merit function // load merit function IMeritFunctionEditorPtr TheMFE = TheSystem->MFE; // need to ensure that you have the Platform set as x64 and not Win32 ISEQOptimizationWizardPtr OptWizard = TheMFE->SEQOptimizationWizard; // Optimize for smallest RMS Spot, which is "Data" = 1 OptWizard->Data = 1; OptWizard->OverallWeight = 1; // Gaussian Quadrature with 3 rings(refers to index number = 2) OptWizard->Ring = 2; // Set air & glass boundaries OptWizard->IsGlassUsed = true; OptWizard->GlassMin = 3.0; OptWizard->GlassMax = 15.0; OptWizard->GlassEdge = 3.0; OptWizard->IsAirUsed = true; OptWizard->AirMin = 0.5; OptWizard->AirMax = 1000.0; OptWizard->AirEdge = 0.5; // And click OK! IWizardPtr baseToolWiz = OptWizard; baseToolWiz->Apply(); _bstr_t mf_filename = _bstr_t(TheApplication->SamplesDir + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization\\\\RMS\_Spot\_Radius.mf"); TheMFE->SaveMeritFunction(mf_filename); TheMFE->LoadMeritFunction(mf_filename); SampleFile = _bstr_t(TheApplication->SamplesDir + "\\\\API\\\\CPP\\\\e15\_Seq\_Optimization\\\\OptimizedFile4.zos"); TheSystem->SaveAs(SampleFile); // Run local optimization and measure time // Local optimization until completion double clo = clock(); ILocalOptimizationPtr LocalOpt = TheSystem->Tools->OpenLocalOptimization(); // need to determine how to check to validity if (LocalOpt != nullptr) { LocalOpt->Algorithm = OptimizationAlgorithm::OptimizationAlgorithm_DampedLeastSquares; LocalOpt->Cycles = OptimizationCycles::OptimizationCycles_Automatic; LocalOpt->NumberOfCores = 8; cout << "Local Optimization..." << endl; cout << "Initial Merit Function " + _bstr_t(LocalOpt->InitialMeritFunction) << endl; ISystemToolPtr baseToolLocal = LocalOpt; baseToolLocal->RunAndWaitForCompletion(); cout << "Final Merit Function " + _bstr_t(LocalOpt->CurrentMeritFunction) << endl; baseToolLocal->Close(); } // Get the elapsed time. cout << "Time elapsed " + _bstr_t((clock() - clo) / 1000) << endl; // run global search int GlobalOptimTimeInSeconds = 15; IGlobalOptimizationPtr GlobalOpt = TheSystem->Tools->OpenGlobalOptimization(); if (GlobalOpt != nullptr) { GlobalOpt->Algorithm = OptimizationAlgorithm::OptimizationAlgorithm_DampedLeastSquares; GlobalOpt->NumberOfCores = 8; cout << "Global Optimization for " << GlobalOptimTimeInSeconds << " seconds..." << endl; cout << "Initial Merit Function " + _bstr_t(GlobalOpt->InitialMeritFunction) << endl; GlobalOpt->NumberToSave = OptimizationSaveCount::OptimizationSaveCount_Save_10; ISystemToolPtr baseToolGlobal = GlobalOpt; baseToolGlobal->RunAndWaitWithTimeout(GlobalOptimTimeInSeconds); for (int j = 1; j <= 10; j++) { cout << _bstr_t(int(j)) + ": " + _bstr_t(GlobalOpt->CurrentMeritFunction(j)) << endl; } baseToolGlobal->Cancel(); // wait for tool to stop running before closing //bool stillRunning = baseToolGlobal->IsRunning; //while (stillRunning) { // stillRunning = baseToolGlobal->IsRunning; //} baseToolGlobal->WaitForCompletion(); baseToolGlobal->Close(); } // run hammer optimization int HammerOptimTimeInSeconds = 15; IHammerOptimizationPtr HammerOpt = TheSystem->Tools->OpenHammerOptimization(); if (HammerOpt != nullptr) { HammerOpt->Algorithm = OptimizationAlgorithm::OptimizationAlgorithm_DampedLeastSquares; HammerOpt->NumberOfCores = 8; cout << "Hammer Optimization for " + _bstr_t(HammerOptimTimeInSeconds) + " seconds..." << endl; cout << "Initial Merit Function " + _bstr_t(HammerOpt->InitialMeritFunction) << endl; ISystemToolPtr baseToolHammer = HammerOpt; baseToolHammer->RunAndWaitWithTimeout(HammerOptimTimeInSeconds); cout << "Final Merit Function " + _bstr_t(HammerOpt->CurrentMeritFunction) << endl; baseToolHammer->Cancel(); baseToolHammer->WaitForCompletion(); baseToolHammer->Close(); } TheSystem->Save(); \#if defined(\_DEBUG) // keeps console open when in debug mode system("pause"); \#endif // Clean up finishStandaloneApplication(TheApplication); return 0; } void handleError(std::string msg) { throw new exception(msg.c_str()); } void logInfo(std::string msg) { printf("%s", msg.c_str()); } void finishStandaloneApplication(IZOSAPI_ApplicationPtr TheApplication) { // Note - TheApplication will close automatically when this application exits, so this isn't strictly necessary in most cases if (TheApplication != nullptr) { TheApplication->CloseApplication(); } } int APIENTRY _tWinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPTSTR lpCmdLine, int nCmdShow) { return RunApplication(); } int _tmain(int argc, _TCHAR* argv[]) { return RunApplication(); } [ZOSAPI.ZOSAPI\_Connection](class_z_o_s_a_p_i_1_1_z_o_s_a_p_i___connection.xhtml) **Definition:** ZemaxService.cs:198 [ZOSAPI.Tools.Tolerancing.TolerancingParameterName.Surface2](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml#a18ffc5c5c02195e015067483e4439229a50ba23165f586b14ed916c6119b06129) @ Surface2 [ZOSAPI.Tools.Tolerancing.TolerancingParameterName.Surface1](namespace_z_o_s_a_p_i_1_1_tools_1_1_tolerancing.xhtml#a18ffc5c5c02195e015067483e4439229a6c4ed555a70d463f08be6c7dd75270ba) @ Surface1 [ZOSAPI](namespace_z_o_s_a_p_i.xhtml) The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,... **Definition:** IAS_FieldCurvatureAndDistortion.cs:5