pycatia.system_interfaces.setting_repository

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.setting_repository.SettingRepository(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

SettingRepository

Represents the base object to handle the parameters of a

setting

get_attr(i_attr_name)

Note

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

o Func GetAttr(CATBSTR iAttrName) As CATVariant

Retieves a attribute.

Parameters:

iAttrName

the attribute name

oAttr

a CATVariant

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_attr_name (str) –

Returns:

CATVariant

get_attr_array(i_attr_name)

Note

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

o Func GetAttrArray(CATBSTR iAttrName) As

CATSafeArrayVariant

Retieves a attribute of type array

Parameters:

iAttrName

the attribute name

oArray

a CATSafeArrayVariant

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_attr_name (str) –

Returns:

tuple

get_attr_info(i_attr_name, admin_level, locked, o_modified)

Note

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

o Sub GetAttrInfo(CATBSTR iAttrName,

CATBSTR AdminLevel,

CATBSTR Locked,

boolean oModified)

Retrieves environment informations for the given

attribute.

Role: This information defines the state of the setting parameter and is

made up of:

The administration level that sets the current value or the value used

to reset it

The administration level that has locked the setting

parameter.

A flag to indicate whether the setting parameter was

modified.

Parameters:

iAttrName

[in] the attribute name.

ioAdminLevel

[inout] The administration level that defines the value used when

resetting the setting parameter.

Legal values:

Default value if the setting parameter has never been

explicitly set in the administration

concatenation.

Set at Admin Level n if the setting parameter has been

administered,

where n is an integer starting from 0 representing the rank of

the administration level.

ioLocked

[inout] A character string to indicate whether the parameter is

locked and the level of administration where the locking has been

proceeded.

Legal values:

Locked at Admin Level n if the setting parameter is locked by

then administration level n,

where n is an integer starting from 0. The setting parameter

can not be modified at the current level.

Locked if the setting parameter is locked by the current

administration level. Only an admistrator can get this

value.

Unlocked if the setting parameter is not

locked

oModified

[out] True to indicate that the setting parameter value has been

explicitely modified at the current administrator or user level. This is only

possible with unlocked parameters. False means that it inherits the

administered value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• i_attr_name (str) –

• admin_level (str) –

• locked (str) –

• o_modified (bool) –

Returns:

None

put_attr(i_attr_name, i_attr)

Note

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

o Sub PutAttr(CATBSTR iAttrName,

CATVariant iAttr)

Sets an attribute of type array.

Parameters:

iAttrName

the attribute name

iArray

a CATSafeArrayVariant.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• i_attr_name (str) –

• i_attr (cat_variant) –

Returns:

None

put_attr_array(i_attr_name, i_array)

Note

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

o Sub PutAttrArray(CATBSTR iAttrName,

CATSafeArrayVariant iArray)

Sets an attribute of type array.

Parameters:

iAttrName

the attribute name

iArray

a CATSafeArrayVariant.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• i_attr_name (str) –

• i_array (tuple) –

Returns:

None

set_attr_lock(i_attr_name, i_locked)

Note

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

o Sub SetAttrLock(CATBSTR iAttrName,

boolean iLocked)

Locks or unlocks an attribute.

Role: Locking a setting attribute prevents the end user, or the

administrators below the current one, from changing the setting parameter

value. Locking or unlocking the attribute setting parameter is an administrator

task and is possible when running a session in the administration mode

only.

Parameters:

iAttrName

[in] the attribute name.

iLocked

[in] A flag to indicate whether the attribute setting parameter

should be locked.

Legal values: True to lock, and False to unlock.

Parameters:

• i_attr_name (str) –

• i_locked (bool) –

Returns:

None