pycatia.system_interfaces.disconnection_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-09 09:53:18.676780

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.system_interfaces.disconnection_setting_att.DisconnectionSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
DisconnectionSettingAtt

Represents the base object to handle the parameters of automatic
disconnection.
If the automatic disconnection is enable, the V5 session will be kill after a
user-defined duration of inactivity.
property activation_state

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)
o Property ActivationState() As boolean

Returns or sets the activation state of automatic
disconnection.
Role:Returns or sets the activation mode of automatic disconnection.
Returns:

bool

get_activation_state_info(admin_level, o_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetActivationStateInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves informations about the activation mode of automatic
disconnection.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_inactivity_duration_info(admin_level, o_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetInactivityDurationInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean

Retrieves environment informations for inactivity
duration.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

property inactivity_duration

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780)
o Property InactivityDuration() As long

Returns or sets the inactivity duration.
Role: Returns or sets the timeout in seconds before the automatic
disconnection when no activity has been detected, if the mechanism is enabled.
Returns:

int

set_activation_state_lock(i_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub SetActivationStateLock(boolean iLocked)

Locks or unlocks the activation mode of automatic
disconnection.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_inactivity_duration_lock(i_locked)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub SetInactivityDurationLock(boolean iLocked)

Locks or unlocks the inactivity duration.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None