pycatia.dnb_human_sim_interfaces.hts_general_setting_att

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_human_sim_interfaces.hts_general_setting_att.HtsGeneralSettingAtt(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

System.SettingController

HtsGeneralSettingAtt

property coll_walk_clearance: float

Note

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

o Property CollWalkClearance() As double

Return type:

float

property collision_search_intensity: int

Note

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

o Property CollisionSearchIntensity() As short

Return type:

int

property constraints_simul: int

Note

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

o Property ConstraintsSimul() As short

Returns or sets the ConstraintsSimul parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property default_walk_speed: float

Note

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

o Property DefaultWalkSpeed() As double

Returns or sets the DefaultWalkSpeed parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

float

get_coll_walk_clearance_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetCollWalkClearanceInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_collision_search_intensity_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetCollisionSearchIntensityInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_constraints_simul_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetConstraintsSimulInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ConstraintsSimul

parameter.

Role:Retrieves the state of the ConstraintsSimul parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_default_walk_speed_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetDefaultWalkSpeedInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DefaultWalkSpeed

parameter.

Role:Retrieves the state of the DefaultWalkSpeed parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_side_step_angle_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetSideStepAngleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SideStepAngle

parameter.

Role:Retrieves the state of the SideStepAngle parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_sync_time_and_speed_in_simulation_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetSyncTimeAndSpeedInSimulationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the SyncTimeAndSpeed

parameter.

Role:Retrieves the state of the SyncTimeAndSpeed parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_update_analysis_in_simulation_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetUpdateAnalysisInSimulationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UpdateAnalysisInSimulation

parameter.

Role:Retrieves the state of the UpdateAnalysisInSimulation parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_user_walk_speed_status_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetUserWalkSpeedStatusInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UserWalkSpeedStatus

parameter.

Role:Retrieves the state of the UserWalkSpeedStatus parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_walk_forward_angle_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetWalkForwardAngleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WalkForwardAngle

parameter.

Role:Retrieves the state of the WalkForwardAngle parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_walk_forward_distance_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetWalkForwardDistanceInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WalkForwardDistance

parameter.

Role:Retrieves the state of the WalkForwardDistance parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

set_coll_walk_clearance_lock(i_locked: bool) → None

Note

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

o Sub SetCollWalkClearanceLock(boolean iLocked)

Parameters:

i_locked (bool) –

Return type:

None

set_collision_search_intensity_lock(i_locked: bool) → None

Note

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

o Sub SetCollisionSearchIntensityLock(boolean iLocked)

Parameters:

i_locked (bool) –

Return type:

None

set_constraints_simul_lock(i_locked: bool) → None

Note

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

o Sub SetConstraintsSimulLock(boolean iLocked)

Locks or unlocks the ConstraintsSimul parameter.

Role:Locks or unlocks the ConstraintsSimul parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_default_walk_speed_lock(i_locked: bool) → None

Note

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

o Sub SetDefaultWalkSpeedLock(boolean iLocked)

Locks or unlocks the DefaultWalkSpeed parameter.

Role:Locks or unlocks the DefaultWalkSpeed parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_side_step_angle_lock(i_locked: bool) → None

Note

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

o Sub SetSideStepAngleLock(boolean iLocked)

Locks or unlocks the SideStepAngle parameter.

Role:Locks or unlocks the SideStepAngle parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_sync_time_and_speed_in_simulation_lock(i_locked: bool) → None

Note

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

o Sub SetSyncTimeAndSpeedInSimulationLock(boolean iLocked)

Locks or unlocks the SyncTimeAndSpeed parameter.

Role:Locks or unlocks the SyncTimeAndSpeed parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_update_analysis_in_simulation_lock(i_locked: bool) → None

Note

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

o Sub SetUpdateAnalysisInSimulationLock(boolean iLocked)

Locks or unlocks the UpdateAnalysisInSimulation parameter.

Role:Locks or unlocks the UpdateAnalysisInSimulation parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_user_walk_speed_status_lock(i_locked: bool) → None

Note

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

o Sub SetUserWalkSpeedStatusLock(boolean iLocked)

Locks or unlocks the UserWalkSpeedStatus parameter.

Role:Locks or unlocks the UserWalkSpeedStatus parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_walk_forward_angle_lock(i_locked: bool) → None

Note

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

o Sub SetWalkForwardAngleLock(boolean iLocked)

Locks or unlocks the WalkForwardAngle parameter.

Role:Locks or unlocks the WalkForwardAngle parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

set_walk_forward_distance_lock(i_locked: bool) → None

Note

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

o Sub SetWalkForwardDistanceLock(boolean iLocked)

Locks or unlocks the WalkForwardDistance parameter.

Role:Locks or unlocks the WalkForwardDistance parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters:

i_locked (bool) –

Return type:

None

property side_step_angle: float

Note

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

o Property SideStepAngle() As double

Returns or sets the SideStepAngle parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

float

property sync_time_and_speed_in_simulation: int

Note

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

o Property SyncTimeAndSpeedInSimulation() As short

Returns or sets the SyncTimeAndSpeed parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property update_analysis_in_simulation: int

Note

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

o Property UpdateAnalysisInSimulation() As short

Returns or sets the UpdateAnalysisInSimulation parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property user_walk_speed_status: int

Note

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

o Property UserWalkSpeedStatus() As short

Returns or sets the UserWalkSpeedStatus parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

int

property walk_forward_angle: float

Note

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

o Property WalkForwardAngle() As double

Returns or sets the WalkForwardAngle parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

float

property walk_forward_distance: float

Note

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

o Property WalkForwardDistance() As double

Returns or sets the WalkForwardDistance parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:

float