pycatia.dnb_human_sim_interfaces.hts_task_display_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_task_display_setting_att.HtsTaskDisplaySettingAtt(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

HtsTaskDisplaySettingAtt

property auto_walk_act_colour: int

Note

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

o Property AutoWalkActColor() As long

Returns or sets the AutoWalkActColor parameter.

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

Return type:

int

property auto_walk_act_line_type: int

Note

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

o Property AutoWalkActLineType() As long

Returns or sets the AutoWalkActLineType parameter.

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

Return type:

int

property auto_walk_act_line_weight: int

Note

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

o Property AutoWalkActLineWeight() As long

Returns or sets the AutoWalkActLineWeight parameter.

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

Return type:

int

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

Note

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

o Func GetAutoWalkActColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoWalkActColor

parameter.

Role:Retrieves the state of the AutoWalkActColor 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_auto_walk_act_line_type_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetAutoWalkActLineTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoWalkActLineType

parameter.

Role:Retrieves the state of the AutoWalkActLineType 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_auto_walk_act_line_weight_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetAutoWalkActLineWeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AutoWalkActLineWeight

parameter.

Role:Retrieves the state of the AutoWalkActLineWeight 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_mtp_act_colour_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetMTPActColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MTPActColor

parameter.

Role:Retrieves the state of the MTPActColor 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_mtp_act_symbol_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetMTPActSymbolInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MTPActSymbol

parameter.

Role:Retrieves the state of the MTPActSymbol 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_act_colour_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetWalkActColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WalkActColor

parameter.

Role:Retrieves the state of the WalkActColor 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_act_line_type_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetWalkActLineTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WalkActLineType

parameter.

Role:Retrieves the state of the WalkActLineType 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_act_line_weight_info(io_admin_level: str, io_locked: str) → bool

Note

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

o Func GetWalkActLineWeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the WalkActLineWeight

parameter.

Role:Retrieves the state of the WalkActLineWeight 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

property mtp_act_colour: int

Note

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

o Property MTPActColor() As long

Returns or sets the MTPActColor parameter.

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

Return type:

int

property mtp_act_symbol: int

Note

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

o Property MTPActSymbol() As long

Returns or sets the MTPActSymbol parameter.

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

Return type:

int

set_auto_walk_act_colour_lock(i_locked: bool) → None

Note

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

o Sub SetAutoWalkActColorLock(boolean iLocked)

Locks or unlocks the AutoWalkActColor parameter.

Role:Locks or unlocks the AutoWalkActColor 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_auto_walk_act_line_type_lock(i_locked: bool) → None

Note

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

o Sub SetAutoWalkActLineTypeLock(boolean iLocked)

Locks or unlocks the AutoWalkActLineType parameter.

Role:Locks or unlocks the AutoWalkActLineType 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_auto_walk_act_line_weight_lock(i_locked: bool) → None

Note

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

o Sub SetAutoWalkActLineWeightLock(boolean iLocked)

Locks or unlocks the AutoWalkActLineWeight parameter.

Role:Locks or unlocks the AutoWalkActLineWeight 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_mtp_act_colour_lock(i_locked: bool) → None

Note

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

o Sub SetMTPActColorLock(boolean iLocked)

Locks or unlocks the MTPActColor parameter.

Role:Locks or unlocks the MTPActColor 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_mtp_act_symbol_lock(i_locked: bool) → None

Note

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

o Sub SetMTPActSymbolLock(boolean iLocked)

Locks or unlocks the MTPActSymbol parameter.

Role:Locks or unlocks the MTPActSymbol 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_act_colour_lock(i_locked: bool) → None

Note

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

o Sub SetWalkActColorLock(boolean iLocked)

Locks or unlocks the WalkActColor parameter.

Role:Locks or unlocks the WalkActColor 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_act_line_type_lock(i_locked: bool) → None

Note

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

o Sub SetWalkActLineTypeLock(boolean iLocked)

Locks or unlocks the WalkActLineType parameter.

Role:Locks or unlocks the WalkActLineType 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_act_line_weight_lock(i_locked: bool) → None

Note

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

o Sub SetWalkActLineWeightLock(boolean iLocked)

Locks or unlocks the WalkActLineWeight parameter.

Role:Locks or unlocks the WalkActLineWeight 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 walk_act_colour: int

Note

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

o Property WalkActColor() As long

Returns or sets the WalkActColor parameter.

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

Return type:

int

property walk_act_line_type: int

Note

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

o Property WalkActLineType() As long

Returns or sets the WalkActLineType parameter.

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

Return type:

int

property walk_act_line_weight: int

Note

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

o Property WalkActLineWeight() As long

Returns or sets the WalkActLineWeight parameter.

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

Return type:

int