ZOS-API interface 2024 R1

ZOSAPI.Editors.MCE.IMCERow Interface Reference

Last update: 17.07.2025

All data for a Multiple Configuration Editor operand. This interface can be accessed via the IMultiConfigEditor interface. More...

Inheritance diagram for ZOSAPI.Editors.MCE.IMCERow:
Inheritance graph
[legend]

Public Member Functions

IEditorCell GetOperandCell (int configuration)
 
Gets the specified operand cell data.
 
MultiConfigOperandType[] AvailableConfigOperandTypes ()
 
bool ChangeType (MultiConfigOperandType type)
 Changes to the specified operand type.
 
- Public Member Functions inherited from ZOSAPI.Editors.IEditorRow
IEditorCell GetCellAt (int pos)
 Gets the cell at the specified index (IEditor.MinColumn to IEditor.MaxColumn).
 

Properties

bool IsActive [get]
 Gets a value indicating whether this instance is active (i.e. refers to a valid operand in the system).
 
int OperandNumber [get]
 Gets the operand number for this row.
 
string TypeName [get]
 
MultiConfigOperandType Type [get]
 Gets the current operand type. Use ChangeType to change the operand type.
 
ZemaxColor RowColor [get, set]
 
int Param1 [get, set]
 
bool Param1Enabled [get]
 
int Param2 [get, set]
 
bool Param2Enabled [get]
 
int Param3 [get, set]
 
bool Param3Enabled [get]
 
- Properties inherited from ZOSAPI.Editors.IEditorRow
IEditor Editor [get]
 Gets the editor this row was retrieved from.
 
bool IsValidRow [get]
 Gets a value indicating whether this instance is currently valid. Note that the RowIndex for this object is fixed, so removing one or more rows from the editor may cause it to be invalid.
 
int RowIndex [get]
 Gets the index of this row in the editor.
 
string RowTypeName [get]
 Gets the type of this row; this can be a surface for the LDE, object for the NCE, etc.
 
string Bookmark [get, set]
 

Detailed Description

All data for a Multiple Configuration Editor operand. This interface can be accessed via the IMultiConfigEditor interface.

Examples
CSharpStandalone_18_SetMulticonfiguration.cs.

Member Function Documentation

◆ AvailableConfigOperandTypes()

MultiConfigOperandType[] ZOSAPI.Editors.MCE.IMCERow.AvailableConfigOperandTypes ( )

◆ ChangeType()

bool ZOSAPI.Editors.MCE.IMCERow.ChangeType ( MultiConfigOperandType  type)

Changes to the specified operand type.

Usage (see Example 18 for a full sample)

C#

// Get interface of each operand
IMCERow MCOperand1 = TheMCE.GetOperandAt(1);
IMCERow MCOperand2 = TheMCE.GetOperandAt(2);
// Change both operands' type to THIC
MCOperand1.ChangeType(MultiConfigOperandType.THIC);
MCOperand2.ChangeType(MultiConfigOperandType.THIC);
ZOSAPI.Editors.MCE.IMCERow
All data for a Multiple Configuration Editor operand. This interface can be accessed via the IMultiCo...
Definition: InterfacesMCE.cs:405
ZOSAPI.Editors.MCE.IMCERow.ChangeType
bool ChangeType(MultiConfigOperandType type)
Changes to the specified operand type.
ZOSAPI.Editors.MCE.MultiConfigOperandType
MultiConfigOperandType
All supported Multi Configuration operand types.
Definition: InterfacesMCE.cs:30

C++

// Get interface of each operand
IMCERowPtr MCOperand1 = TheMCE->GetOperandAt(1);
IMCERowPtr MCOperand2 = TheMCE->GetOperandAt(2);
// Change both operands' type to THIC
MCOperand1->ChangeType(MultiConfigOperandType_THIC);
MCOperand2->ChangeType(MultiConfigOperandType_THIC);

Matlab

% Get interface of each operand
MCOperand1 = TheMCE.GetOperandAt(1);
MCOperand2 = TheMCE.GetOperandAt(2);
% Change both operands' type to THIC
MCOperand1.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC);
MCOperand2.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC);

Python

# Get interface of each operand
MCOperand1 = TheMCE.GetOperandAt(1)
MCOperand2 = TheMCE.GetOperandAt(2)
# Change both operands' type to THIC
MCOperand1.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC)
MCOperand2.ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.THIC)
Parameters
typeThe type.
Returns
true if the change was successful; otherwise, false.
Examples
CSharpStandalone_18_SetMulticonfiguration.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

◆ GetOperandCell()

IEditorCell ZOSAPI.Editors.MCE.IMCERow.GetOperandCell ( int  configuration)


Gets the specified operand cell data.

Usage (see Example 18 for a full sample)

C#

// Set values of opeand for each configurations
MCOperand1.GetOperandCell(1).DoubleValue = 10000.0;
MCOperand1.GetOperandCell(2).DoubleValue = 5000.0;
MCOperand1.GetOperandCell(3).DoubleValue = 1000.0;

C++

// Set values of opeand for each configurations
MCOperand1->GetOperandCell(1)->DoubleValue = 10000.0;
MCOperand1->GetOperandCell(2)->DoubleValue = 5000.0;
MCOperand1->GetOperandCell(3)->DoubleValue = 1000.0;

Matlab

% Set values of operand for each configuration
MCOperand1.GetOperandCell(1).DoubleValue = 10000.0;
MCOperand1.GetOperandCell(2).DoubleValue = 5000.0;
MCOperand1.GetOperandCell(3).DoubleValue = 1000.0;

Python

# Set values of operand for each configuration
MCOperand1.GetOperandCell(1).DoubleValue = 10000.0
MCOperand1.GetOperandCell(2).DoubleValue = 5000.0
MCOperand1.GetOperandCell(3).DoubleValue = 1000.0
Parameters
configurationThe configuration.
Returns
Examples
CSharpStandalone_18_SetMulticonfiguration.cs, and CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

Property Documentation

◆ IsActive

bool ZOSAPI.Editors.MCE.IMCERow.IsActive
get

Gets a value indicating whether this instance is active (i.e. refers to a valid operand in the system).

true if this instance is active; otherwise, false.

◆ OperandNumber

int ZOSAPI.Editors.MCE.IMCERow.OperandNumber
get

Gets the operand number for this row.

The operand number.

◆ Param1

int ZOSAPI.Editors.MCE.IMCERow.Param1
getset

Usage (see Example 18 for a full sample)

C#

// Set parameters of operands
// If the type of operand is THIC, the first parameter here means surface number
MCOperand1.Param1 = 0;
MCOperand2.Param1 = 11;

C++

// Set parameters of operands
// If the type of operand is THIC, the first parameter here means surface number
MCOperand1->Param1 = 0;
MCOperand2->Param1 = 11;

Matlab

% Set parameters of operands
% If the type of operand is THIC, the first parameter here means surface number
MCOperand1.Param1 = 0;
MCOperand2.Param1 = 11;

Python

# Set parameters of operands
# If the type of operand is THIC, the first parameter here means surface number
MCOperand1.Param1 = 0
MCOperand2.Param1 = 11
Examples
CSharpStandalone_18_SetMulticonfiguration.cs.

◆ Param1Enabled

bool ZOSAPI.Editors.MCE.IMCERow.Param1Enabled
get

◆ Param2

int ZOSAPI.Editors.MCE.IMCERow.Param2
getset

Usage (see Example 25 for a full sample)

C#

// change MCE to NPAR, modifies the number of Layout Rays for a Source
for (int a = 1; a <= 4; a++)
{
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR);
}
TheMCE.GetOperandAt(1).Param2 = 1;
TheMCE.GetOperandAt(1).Param3 = 1;
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200;
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0;
ZOSAPI.Editors.MCE
Definition: InterfacesMCE.cs:11
ZOSAPI.Editors
Definition: InterfacesEditors.cs:12
ZOSAPI
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5

C++

// change MCE to NPAR, modifies the number of Layout Rays for a Source
for (int a = 1; a < 5; a++)
TheMCE->GetOperandAt(a)->ChangeType(MultiConfigOperandType_NPAR);
TheMCE->GetOperandAt(1)->Param2 = 1;
TheMCE->GetOperandAt(1)->Param3 = 1;
TheMCE->GetOperandAt(1)->GetOperandCell(1)->DoubleValue = 200;
TheMCE->GetOperandAt(1)->GetOperandCell(2)->DoubleValue = 0;

Matlab

% change MCE to NPAR, modifies the number of Layout Rays for a Source
for a = 1:4
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR);
end
TheMCE.GetOperandAt(1).Param2 = 1;
TheMCE.GetOperandAt(1).Param3 = 1;
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200;
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0;
ZOSAPI.Editors.EditorType.MCE
@ MCE
Multiple Configuration Editor.

Python

# change MCE to NPAR, modifies the number of Layout Rays for a Source
for a in range(1, 5):
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR)
TheMCE.GetOperandAt(1).Param2 = 1
TheMCE.GetOperandAt(1).Param3 = 1
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0
Examples
CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

◆ Param2Enabled

bool ZOSAPI.Editors.MCE.IMCERow.Param2Enabled
get

◆ Param3

int ZOSAPI.Editors.MCE.IMCERow.Param3
getset

Usage (see Example 25 for a full sample)

C#

// change MCE to NPAR, modifies the number of Layout Rays for a Source
for (int a = 1; a <= 4; a++)
{
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR);
}
TheMCE.GetOperandAt(1).Param2 = 1;
TheMCE.GetOperandAt(1).Param3 = 1;
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200;
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0;

C++

// change MCE to NPAR, modifies the number of Layout Rays for a Source
for (int a = 1; a < 5; a++)
TheMCE->GetOperandAt(a)->ChangeType(MultiConfigOperandType_NPAR);
TheMCE->GetOperandAt(1)->Param2 = 1;
TheMCE->GetOperandAt(1)->Param3 = 1;
TheMCE->GetOperandAt(1)->GetOperandCell(1)->DoubleValue = 200;
TheMCE->GetOperandAt(1)->GetOperandCell(2)->DoubleValue = 0;

Matlab

% change MCE to NPAR, modifies the number of Layout Rays for a Source
for a = 1:4
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR);
end
TheMCE.GetOperandAt(1).Param2 = 1;
TheMCE.GetOperandAt(1).Param3 = 1;
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200;
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0;

Python

# change MCE to NPAR, modifies the number of Layout Rays for a Source
for a in range(1, 5):
TheMCE.GetOperandAt(a).ChangeType(ZOSAPI.Editors.MCE.MultiConfigOperandType.NPAR)
TheMCE.GetOperandAt(1).Param2 = 1
TheMCE.GetOperandAt(1).Param3 = 1
TheMCE.GetOperandAt(1).GetOperandCell(1).DoubleValue = 200
TheMCE.GetOperandAt(1).GetOperandCell(2).DoubleValue = 0
Examples
CSharpStandalone_25_source_spectrum_diffraction_grating.cs.

◆ Param3Enabled

bool ZOSAPI.Editors.MCE.IMCERow.Param3Enabled
get

◆ RowColor

ZemaxColor ZOSAPI.Editors.MCE.IMCERow.RowColor
getset

◆ Type

MultiConfigOperandType ZOSAPI.Editors.MCE.IMCERow.Type
get

Gets the current operand type. Use ChangeType to change the operand type.

The type.

◆ TypeName

string ZOSAPI.Editors.MCE.IMCERow.TypeName
get

Connect with Ansys