pycatia.dnb_simulation_interfaces.simulation_init_state

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.dnb_simulation_interfaces.simulation_init_state.SimulationInitState(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
SimulationInitState

Interface used to save/restore the simulation initial state.

Role: This interface is used to save/restore the initial state for objects in
the current document.
The following code snippet can be used to save the simulation initial state for
all the objects in the current document (all attributes). The rootProduct can
be any product from the current document.

Dim iMask
iMask = DNBAllInitStateAttr

Dim iSimInitState As SimulationInitState
Set iSimInitState = rootProduct.GetTechnologicalObject(“SimulationInitState”)
iSimInitState.SaveInitialState iMask
restore_initial_state(i_attr_mask: int) → None

Note

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

Restores initial state attributes for all objects in the current document
that have a saved initial state.

Parameters:

iAttrMask
Indicates which initial state attributes will be restored

Returns:
An HRESULT.
Legal values:

S_OK
The restore operation succeeded
E_FAIL
The restore operation failed
Parameters:

i_attr_mask (int) – enum dnb_sim_init_state_attr

Return type:

None

restore_initial_state_list(i_product_lists: tuple, i_attr_mask: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RestoreInitialStateList(CATSafeArrayVariant
iProductLists,
DNBSimInitStateAttr iAttrMask)

Restores initial state attributes for the objects in the given
list.

Parameters:

iProductLists
Indicates which objects will be used for the restore initial state
operation
iAttrMask
Indicates which initial state attributes will be restored

Returns:
An HRESULT.
Legal values:

S_OK
The restore operation succeeded
E_FAIL
The restore operation failed
Parameters:

  • i_product_lists (tuple) –

  • i_attr_mask (int) – enum dnb_sim_init_state_attr

Return type:

None

save_initial_state(i_attr_mask: int) → None

Note

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

Saves initial state attributes for all objects in the current
document.

Parameters:

iAttrMask
Indicates which initial state attributes will be saved

Returns:
An HRESULT.
Legal values:

S_OK
The save operation succeeded
E_FAIL
The save operation failed
Parameters:

i_attr_mask (int) – enum dnb_sim_init_state_attr

Return type:

None

save_initial_state_list(i_product_lists: tuple, i_attr_mask: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SaveInitialStateList(CATSafeArrayVariant
iProductLists,
DNBSimInitStateAttr iAttrMask)

Saves initial state attributes for the objects in the given
list.

Parameters:

iProductLists
Indicates which objects will be used for the save initial state
operation
iAttrMask
Indicates which initial state attributes will be saved

Returns:
An HRESULT.
Legal values:

S_OK
The save operation succeeded
E_FAIL
The save operation failed
Parameters:

  • i_product_lists (tuple) –

  • i_attr_mask (int) – enum dnb_sim_init_state_attr

Return type:

None