OptionSetting Class

class NXOpen.CAE.FTK.OptionSetting

Bases: object

Manager the options data for AFU Data Record

Not support KF.

New in version NX6.0.0.

Methods

Method Description
GetHeaderFlag Get the adding header flag when export to CSV file @return If want to add header when export to CSV file
GetOptionData Get the options data for an AFU Data Record
GetRecordOptionData Get the record options data for an AFU Data Record
SetHeaderFlag Set the adding header flag when export to CSV file
SetOptionData Set the options data for an AFU Data Record
SetRecordOptionData Set the record options data for an AFU Data Record

Method Detail

GetHeaderFlag

OptionSetting.GetHeaderFlag

Get the adding header flag when export to CSV file

Signature GetHeaderFlag()

Returns:If want to add header when export to CSV file
Return type:bool

New in version NX7.5.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetOptionData

OptionSetting.GetOptionData

Get the options data for an AFU Data Record

Signature GetOptionData()

Returns:a tuple
Return type:A tuple consisting of (recordName, functionType, abscissaType, xUnit, oridinateType, yUnit, sortValueType). recordName is a str. The name of the AFU Data Record functionType is a NXOpen.CAE.XyFunctionGeneralType. Usage type of AFU Data Record used abscissaType is a NXOpen.CAE.AfuDataAbscissaType. Abscissa specific data type xUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of AFU data oridinateType is a NXOpen.CAE.AfuDataOrdinateType. Ordinate specific data type yUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of AFU data sortValueType is a bool. If want to sort value in x direction

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use NXOpen.CAE.FTK.OptionSetting.GetRecordOptionData with Denominator.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetRecordOptionData

OptionSetting.GetRecordOptionData

Get the record options data for an AFU Data Record

Signature GetRecordOptionData()

Returns:a tuple
Return type:A tuple consisting of (recordName, functionType, abscissaType, xUnit, ordinateType, yUnit, yDenominatorUnit, sortValueType). recordName is a str. The name of the AFU Data Record functionType is a NXOpen.CAE.XyFunctionGeneralType. Usage type of AFU Data Record used abscissaType is a NXOpen.CAE.AfuDataAbscissaType. Abscissa specific data type xUnit is a NXOpen.CAE.XyFunctionUnit. Unit Code of AFU data ordinateType is a NXOpen.CAE.AfuDataOrdinateType. Ordinate data type yUnit is a NXOpen.CAE.XyFunctionUnit. Ordinate Numerator Unit Code of AFU data yDenominatorUnit is a NXOpen.CAE.XyFunctionUnit. Ordinate Denominator Unit Code of AFU data sortValueType is a bool. If want to sort value in x direction

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetHeaderFlag

OptionSetting.SetHeaderFlag

Set the adding header flag when export to CSV file

Signature SetHeaderFlag(addHeader)

Parameters:addHeader (bool) – If want to add header when export to CSV file

New in version NX7.5.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetOptionData

OptionSetting.SetOptionData

Set the options data for an AFU Data Record

Signature SetOptionData(recordName, functionType, abscissaType, xUnit, oridinateType, yUnit, sortValueType)

Parameters:

New in version NX6.0.0.

Deprecated since version NX9.0.0: Use NXOpen.CAE.FTK.OptionSetting.SetRecordOptionData with Denominator.

License requirements: nx_ftk (“NX Advanced Graphing”)

SetRecordOptionData

OptionSetting.SetRecordOptionData

Set the record options data for an AFU Data Record

Signature SetRecordOptionData(recordName, functionType, abscissaType, xUnit, ordinateType, yUnit, yDenominatorUnit, sortValueType)

Parameters:

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)