ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField Interface Reference
Last update: 17.07.2025Provides methods for setting and inspecting the field configuration for a Quick Yield analysis. More...
Public Member Functions | |
| int | GetFieldUser () |
| Gets a value which specifies the User Defined field the Quick Yield analysis is configured to use. | |
| XYSymmetricField | GetFieldSymmetricXY () |
| Gets a value which specifies the XY-symmetric field the Quick Yield analysis is configured to use. | |
| YSymmetricField | GetFieldSymmetricY () |
| Gets a value which specifies the Y-symmetric field the Quick Yield analysis is configured to use. | |
| IMessage | SetFieldUser (int fieldNumber) |
| Configures the Quick Yield analysis to use a user-defined field. | |
| IMessage | SetFieldSymmetricXY (XYSymmetricField field) |
| Configures the Quick Yield analysis to use a field from the XY-symmetric set of fields. | |
| IMessage | SetFieldSymmetricY (YSymmetricField field) |
| Configures the Quick Yield analysis to use a field from the Y-symmetric set of fields. | |
Properties | |
| bool | IsFieldUser [get] |
| Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of user-defined fields. | |
| bool | IsFieldSymmetricXY [get] |
| Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of XY-symmetric fields. | |
| bool | IsFieldSymmetricY [get] |
| Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of Y-symmetric fields. | |
Detailed Description
Provides methods for setting and inspecting the field configuration for a Quick Yield analysis.
Member Function Documentation
◆ GetFieldSymmetricXY()
| XYSymmetricField ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.GetFieldSymmetricXY | ( | ) |
Gets a value which specifies the XY-symmetric field the Quick Yield analysis is configured to use.
- Returns
- The XY-symmetric field the Quick Yield analysis is configured to use.
◆ GetFieldSymmetricY()
| YSymmetricField ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.GetFieldSymmetricY | ( | ) |
Gets a value which specifies the Y-symmetric field the Quick Yield analysis is configured to use.
- Returns
- The Y-symmetric field the Quick Yield analysis is configured to use.
◆ GetFieldUser()
| int ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.GetFieldUser | ( | ) |
Gets a value which specifies the User Defined field the Quick Yield analysis is configured to use.
- Returns
- The 1-based field number the Quick Yield analysis is configured to use. A value of
0means- "all fields" when there are at most twelve user-defined fields and
- "first 12" when there are more than twelve user-defined fields.
◆ SetFieldSymmetricXY()
| IMessage ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.SetFieldSymmetricXY | ( | XYSymmetricField | field | ) |
Configures the Quick Yield analysis to use a field from the XY-symmetric set of fields.
- Parameters
-
field The field to use in the Quick Yield analysis.
- Returns
- A message indicating the success or failure of the operation. Null indicates success.
◆ SetFieldSymmetricY()
| IMessage ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.SetFieldSymmetricY | ( | YSymmetricField | field | ) |
Configures the Quick Yield analysis to use a field from the Y-symmetric set of fields.
- Parameters
-
field The field to use in the Quick Yield analysis.
- Returns
- A message indicating the success or failure of the operation. Null indicates success.
◆ SetFieldUser()
| IMessage ZOSAPI.Analysis.Tolerancing.QuickYield.IAS_QYField.SetFieldUser | ( | int | fieldNumber | ) |
Configures the Quick Yield analysis to use a user-defined field.
- Parameters
-
fieldNumber The (1-based) field number or 0. The value0means "All" for a system with at most twelve user-defined fields; it means "First 12" for a system with more than twelve user- defined fields.
- Returns
- A message indicating the success or failure of the operation. Null indicates success.
Property Documentation
◆ IsFieldSymmetricXY
|
get |
Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of XY-symmetric fields.
◆ IsFieldSymmetricY
|
get |
Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of Y-symmetric fields.
◆ IsFieldUser
|
get |
Gets a value indicating whether the field Quick Analysis is configured to use comes from the set of user-defined fields.
