ZOS-API interface 2024 R1

ZOSAPI.SystemData.IField Interface Reference

Last update: 17.07.2025

System field data. This interface can be accessed via the IFields interface. More...

Public Member Functions

ISolveData GetXSolveData ()
 
SolveStatus SetXPickup (int fromField, FieldColumn fromColumn, double scale, double offset)
 
SolveStatus SetXFixed ()
 
ISolveData GetYSolveData ()
 
SolveStatus SetYPickup (int fromField, FieldColumn fromColumn, double scale, double offset)
 
SolveStatus SetYFixed ()
 
ISolveData GetSolveData (FieldColumn forColumn)
 
SolveStatus SetPickup (FieldColumn forColumn, int fromField, FieldColumn fromColumn, double scale, double offset)
 
SolveStatus SetFixed (FieldColumn forColumn)
 

Properties

bool IsActive [get]
 
int FieldNumber [get]
 
double X [get, set]
 
double Y [get, set]
 
double Weight [get, set]
 
double VDX [get, set]
 
double VDY [get, set]
 
double VCX [get, set]
 
double VCY [get, set]
 
double VAN [get, set]
 
double TAN [get, set]
 
string Comment [get, set]
 
SolveType XSolve [get]
 
SolveType YSolve [get]
 
bool Ignore [get, set]
 

Detailed Description

System field data. This interface can be accessed via the IFields interface.

Usage (see Example 12 for a full example)

C#

// Change field 1 to be X=1.0 and Y=2.0
ZOSAPI.SystemData.IField field1 = sysField.GetField(1);
field1.X = 1.0;
field1.Y = 2.0;
ZOSAPI.SystemData.IField
System field data. This interface can be accessed via the IFields interface.
Definition: InterfacesSE.cs:975

C++

// Change field 1 to be X=1.0 and Y=2.0
ZOSAPI_Interfaces::IFieldPtr field1 = sysField->GetField(1);
field1->X = 1.0;
field1->Y = 2.0;

Matlab

% Change field 1 to be X=1.0 and Y=2.0
field1 = sysField.GetField(1);
field1.X = 1.0;
field1.Y = 2.0;

Python

# Change field 1 to be x=1.0 and y=2.0
field1 = sysField.GetField(1)
field1.X = 1.0
field1.Y = 2.0


Examples
CSharpStandalone_01_new_file_and_quickfocus.cs, CSharpStandalone_12_Seq_SystemExplorer.cs, and CSharpStandalone_15_Seq_Optimization.cs.

Member Function Documentation

◆ GetSolveData()

ISolveData ZOSAPI.SystemData.IField.GetSolveData ( FieldColumn  forColumn)

◆ GetXSolveData()

ISolveData ZOSAPI.SystemData.IField.GetXSolveData ( )

◆ GetYSolveData()

ISolveData ZOSAPI.SystemData.IField.GetYSolveData ( )

◆ SetFixed()

SolveStatus ZOSAPI.SystemData.IField.SetFixed ( FieldColumn  forColumn)

◆ SetPickup()

SolveStatus ZOSAPI.SystemData.IField.SetPickup ( FieldColumn  forColumn,
int  fromField,
FieldColumn  fromColumn,
double  scale,
double  offset 
)

◆ SetXFixed()

SolveStatus ZOSAPI.SystemData.IField.SetXFixed ( )

◆ SetXPickup()

SolveStatus ZOSAPI.SystemData.IField.SetXPickup ( int  fromField,
FieldColumn  fromColumn,
double  scale,
double  offset 
)

◆ SetYFixed()

SolveStatus ZOSAPI.SystemData.IField.SetYFixed ( )

◆ SetYPickup()

SolveStatus ZOSAPI.SystemData.IField.SetYPickup ( int  fromField,
FieldColumn  fromColumn,
double  scale,
double  offset 
)

Property Documentation

◆ Comment

string ZOSAPI.SystemData.IField.Comment
getset

◆ FieldNumber

int ZOSAPI.SystemData.IField.FieldNumber
get

◆ Ignore

bool ZOSAPI.SystemData.IField.Ignore
getset

◆ IsActive

bool ZOSAPI.SystemData.IField.IsActive
get

◆ TAN

double ZOSAPI.SystemData.IField.TAN
getset

◆ VAN

double ZOSAPI.SystemData.IField.VAN
getset

◆ VCX

double ZOSAPI.SystemData.IField.VCX
getset

◆ VCY

double ZOSAPI.SystemData.IField.VCY
getset

◆ VDX

double ZOSAPI.SystemData.IField.VDX
getset

◆ VDY

double ZOSAPI.SystemData.IField.VDY
getset

◆ Weight

double ZOSAPI.SystemData.IField.Weight
getset

◆ X

double ZOSAPI.SystemData.IField.X
getset

◆ XSolve

SolveType ZOSAPI.SystemData.IField.XSolve
get

◆ Y

double ZOSAPI.SystemData.IField.Y
getset

Usage (see Example 22 for a full sample)

C#

// Determine maximum field in Y only
double max_field = 0.0;
for (int i = 1; i <= num_fields; i++)
{
if (TheSystem.SystemData.Fields.GetField(i).Y > max_field)
{
max_field = TheSystem.SystemData.Fields.GetField(i).Y;
}
}

C++

// Determine maximum field in Y only
double max_field = 0.0;
for (int i = 1; i <= num_fields; i++) {
if (TheSystem->SystemData->Fields->GetField(i)->Y > max_field) {
max_field = TheSystem->SystemData->Fields->GetField(i)->Y;
}
}

Matlab

% determine maximum field in Y only
max_field = 0;
for i=1:TheSystem.SystemData.Fields.NumberOfFields
if TheSystem.SystemData.Fields.GetField(i).Y > max_field; max_field = TheSystem.SystemData.Fields.GetField(i).Y ; end;
end

Python

# Determine maximum field in Y only
max_field = 0.0
for i in range(1, num_fields + 1):
if (TheSystem.SystemData.Fields.GetField(i).Y > max_field):
max_field = TheSystem.SystemData.Fields.GetField(i).Y

◆ YSolve

SolveType ZOSAPI.SystemData.IField.YSolve
get

Connect with Ansys