pycatia.abq_automation_interfaces.abqfh_output_request

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.abq_automation_interfaces.abqfh_output_request.ABQFHOutputRequest(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

ABQAutomationItf.ABQOutputRequest

ABQFHOutputRequest

Represents the base interface for field and history output request

objects.

Role: The ABQFHOutputRequest interface manages the common properties of field

and history output requests.

property equally_spaced_incr: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property EquallySpacedIncr(long iAtEquallySpacedIncr) (Write

Only)

For explicit dynamic step: Sets request for output results at equally

spaced increments.

Parameters:

iAtEquallySpacedIncr

The increment number which allows the user to set output results at

this interval

Return type:

int

property every_x_incr_of_time: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property EveryXIncrOfTime(double iAtEveryXIncr) (Write

Only)

For explicit dynamic step: Sets request for output results at every

specified units of time.

Parameters:

iAtEveryXIncr

The time interval which allows the user to set output results at

this interval

Return type:

int

property output_at_def_or_all_sec_pts: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property OutputAtDefOrAllSecPts(ABQOutputAtSecPts iOutputAtSecPts) (Write

Only)

Sets request for output results at section points.

Parameters:

iOutputAtSecPts

The option to request output results at section points: Default or

All

Legal values:

“ABQDEFAULTSECPTS”

“ABQALLSECPTS”

Returns:

enum abq_output_at_sec_pts

Return type:

int

property pre_select_default_or_all: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property PreSelectDefaultOrAll(ABQOutputVariableType iOutputVarType) (Write

Only)

Sets request for results for preselect default or ALL

variables.

Parameters:

iOutputVarType

The option to request output results for set of variables:

Preselected or All

Legal values:

“ABQPRESELECTDEFVAR”

“ABQALLVAR”

Returns:

enum abq_output_variable_type

Return type:

int

set_output_at_all_modes() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub SetOutputAtAllModes()

For frequency step: Sets request for output results at all modes.

Return type:

None

property specified_modes: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property SpecifiedModes(CATSafeArrayVariant iSpecifiedModes) (Write

Only)

For frequency step: Sets request for output results at specified

modes.

Parameters:

iSpecifiedModes

The list of modes for which output is requested

Return type:

int

property specified_output_variables: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property SpecifiedOutputVariables(CATBSTR iVariableNameBSTR) (Write

Only)

Sets the specified variables for which results are

requested.

Parameters:

iVariableNameBSTR

The list of variables for which output is requested For example: If

user wants to request output for variables ‘U’ and ‘S’, then iVariableNameBSTR

will be “U, S”

Return type:

int

property specified_sec_pts: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property SpecifiedSecPts(CATSafeArrayVariant iSpecifiedSecPts) (Write

Only)

Sets request for output results at specified section

points.

Parameters:

iSpecifiedSecPts

The list of section points at which output is

requested

Return type:

int

property timing_flag: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property TimingFlag() As boolean

Returns or sets a flag for output at approximate or exact times. A true

value indicates that request for output results at approximate times and a

false value for output results at exact times.

Returns:

A boolean specifying whether request for output results at approximate

or exact times.

Return type:

bool