pycatia.knowledge_interfaces.knowledge_sheet_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.knowledge_interfaces.knowledge_sheet_setting_att.KnowledgeSheetSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

KnowledgeSheetSettingAtt

The interface to access a CATIAKnowledgeSheetSettingAtt.

This interface may be used to read or modify in the CATIA/Tools/Option the

settings values of Knowledge sheet.

property design_tables_copy_data: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DesignTablesCopyData() As short

Returns or sets the DesignTablesCopyData parameter.

Role:Return or Set the DesignTablesCopyData parameter if it is possible in

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

E_FAIL.

Parameters:

oDesignTablesCopyData

Legal values:

0 : default mode for design table : copy data into models

1 : default mode for design table : do not copy data into models.

Return type:

int

property design_tables_synchronization: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DesignTablesSynchronization() As short

Returns or sets the DesignTablesSynchronization parameter.

Role:Return or Set the DesignTablesSynchronization parameter if it is

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

always return E_FAIL.

Parameters:

oDesignTablesSynchronization

Legal values:

0 : automatic synchronization at load for design table

1 : interactive synchronization at load for design table

2 : manual synchronization for design table.

Return type:

int

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDesignTablesCopyDataInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesCopyData

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDesignTablesSynchronizationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DesignTablesSynchronization

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetParameterNameSurroundedByTheSymbolInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

ParameterNameSurroundedByTheSymbol parameter.

Role:Retrieves the state of the ParameterNameSurroundedByTheSymbol

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_parameter_tree_view_with_formula_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetParameterTreeViewWithFormulaInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithFormula

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetParameterTreeViewWithValueInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ParameterTreeViewWithValue

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextEvaluateDuringUpdate 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_relations_update_in_part_context_synchronous_relations_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetRelationsUpdateInPartContextSynchronousRelationsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the

RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Retrieves the state of the

RelationsUpdateInPartContextSynchronousRelations 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 parameter_name_surrounded_by_the_symbol: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ParameterNameSurroundedByTheSymbol() As short

Returns or sets the ParameterNameSurroundedByTheSymbol

parameter.

Role:Return or Set the ParameterNameSurroundedByTheSymbol parameter if it

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

will always return E_FAIL.

Parameters:

oParameterNameSurroundedByTheSymbol

Legal values:

0 : to see parameter name not surrounded by the symbol “’”

1 : to see parameter name surrounded by the symbol “’”.

Return type:

int

property parameter_tree_view_with_formula: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ParameterTreeViewWithFormula() As short

Returns or sets the ParameterTreeViewWithFormula

parameter.

Role:Return or Set the ParameterTreeViewWithFormula parameter if it is

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

always return E_FAIL.

Parameters:

oParameterTreeViewWithFormula

Legal values:

0 : to see parameter tree view without formula

1 : to see parameter tree view with formula.

Return type:

int

property parameter_tree_view_with_value: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ParameterTreeViewWithValue() As short

Returns or sets the ParameterTreeViewWithValue parameter.

Role:Return or Set the ParameterTreeViewWithValue parameter if it is

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

always return E_FAIL.

Parameters:

oParameterTreeViewWithValue

Legal values:

0 : to see parameter tree view without value

1 : to see parameter tree view with value.

Return type:

int

property relations_update_in_part_context_evaluate_during_update: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property RelationsUpdateInPartContextEvaluateDuringUpdate() As

short

Returns or sets the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Return or Set the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextEvaluateDuringUpdate

Legal values:

0 : creation of relations not evaluate during update

1 : creation of relations evaluate during update.

Return type:

int

property relations_update_in_part_context_synchronous_relations: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property RelationsUpdateInPartContextSynchronousRelations() As

short

Returns or sets the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Return or Set the RelationsUpdateInPartContextSynchronousRelations

parameter if it is possible in the current administrative context. In user mode

this method will always return E_FAIL.

Parameters:

oRelationsUpdateInPartContextSynchronousRelations

Legal values:

0 : creation of unsynchronous relations

1 : creation of synchronous relations.

Return type:

int

set_design_tables_copy_data_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDesignTablesCopyDataLock(boolean iLocked)

Locks or unlocks the DesignTablesCopyData parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDesignTablesSynchronizationLock(boolean iLocked)

Locks or unlocks the DesignTablesSynchronization

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetParameterNameSurroundedByTheSymbolLock(boolean

iLocked)

Locks or unlocks the ParameterNameSurroundedByTheSymbol

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetParameterTreeViewWithFormulaLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithFormula

parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetParameterTreeViewWithValueLock(boolean iLocked)

Locks or unlocks the ParameterTreeViewWithValue parameter.

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetRelationsUpdateInPartContextEvaluateDuringUpdateLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate

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_relations_update_in_part_context_synchronous_relations_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetRelationsUpdateInPartContextSynchronousRelationsLock(boolean

iLocked)

Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

parameter.

Role:Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations

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) –

Returns:

None