pycatia.abq_automation_interfaces.abq_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.abq_output_request.ABQOutputRequest(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
ABQOutputRequest

Represents the base interface for all output request objects.
Role: The ABQOutputRequest interface manages the common attributes of any
output requests.
property activation_status: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ActivationStatus() As boolean

Sets or returns the activation status.

Returns:
A boolean specifying whether the output request is activated or
deactivated.
Return type:

bool

add_support_from_product(i_product: Product, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromProduct(Product iProduct,
Reference iSupport)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iProduct
The CATIA Product specifying the object to which the output request
is applied.
iSupport
The CATIA Reference specifying the region to which the output
request is applied.

Refer: CATIAReference , CATIAProduct
Parameters:
Return type:

None

add_support_from_publication(i_product: Product, i_publication: Publication) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromPublication(Product iProduct,
Publication iPublication)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iProduct
The CATIA Product specifying the object to which the output request
is applied.
iPublication
The CATIA Publication specifying the region to which the output
request is applied.

Refer: CATIAPublication
Parameters:
Return type:

None

add_support_from_reference(i_reference: Reference, i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddSupportFromReference(Reference iReference,
Reference iSupport)

Creates a new support and adds it to the description of the Analysis
Entity.

Parameters:

iReference
The CATIA Reference specifying the object to which the output
request is applied.
iSupport
The CATIA Reference specifying the region to which the output
request is applied.

Refer: CATIAReference
Parameters:
Return type:

None

property num_increment_frequency: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property NumIncrementFrequency(long iNumIncrementFrequency) (Write
Only)

Sets request for output results at specified increment.
Return type:

int

set_output_at_last_increment() → None

Note

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

Sets request for output results at last increment.
Return type:

None

property status: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Status() As CATBSTR (Read Only)

Returns the propagating status of the output request.

Returns:
The propagating status for example: if the output request feature is
created, it will return “CREATED” if the output request feature is propagated
from previous step, it will return “PROPAGATED” if the output request feature
is modified in current step, it will return “MODIFIED”
Return type:

str

property type: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Type() As CATBSTR (Read Only)

Returns the type of the output request.

Returns:
The string representing the type of the output request.
Return type:

str

property whole_model_as_supp: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property WholeModelAsSupp() As boolean

Sets or returns whether the whole model is selected as support. A value of
true indicates that the whole model is selected as
support.

Returns:
A boolean specifying whether the whole model is selected as support.
Return type:

bool