pycatia.system_interfaces.cache_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.cache_setting_att.CacheSettingAtt(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
CacheSettingAtt

Represents the base object to handle the parameters of the
cache.
property activation_mode

Note

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

Returns or sets the activation state of cache.
Role: Returns or sets the value of cache activation.
Returns:

bool

property cache_max_size_mo

Note

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

Returns or sets the value of the cache maximum size.
Role: Returns or sets the value of the maximum allowed cache size in Mo
Returns:

int

get_activation_mode_info(admin_level, o_locked)

Note

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

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

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_cache_max_size_mo_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the Cache maximum
size.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_local_path_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the Cache local
path.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_lod_mode_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the LOD generation
mode.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_release_path()

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Func GetReleasePath() As CATSafeArrayVariant

Retieves the cache release paths.
Role: Sets the cache release paths in a symbolic format.

Parameters:

ioRelPath
a CATSafeArrayVariant of CATBSTR.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Returns:

tuple

get_release_path_info(admin_level, locked)

Note

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

Retrieves environment informations for the Cache release
path.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • locked (str) –

Returns:

None

get_released_voxel_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the Cache released
voxel.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_size_control_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the size control
mode.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_timestamp_mode_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the timestamp control
mode.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

get_utc_time_format_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the timestamp control
mode.
Refer to SettingController for a detailed description.
Parameters:

  • admin_level (str) –

  • o_locked (str) –

Returns:

None

property local_path

Note

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

Retrieves or sets the cache local path.
Role: Retrieves or sets the value of the cache local path. If the local
path is defined with environment variables then this method return the
unexpansed form.
Returns:

str

property lod_mode

Note

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

Returns or sets the LOD generation mode parameter.
Role: Returns or sets the value of the LOD generation mode.
Returns:

bool

put_release_path(i_rel_path)

Note

CAA V5 Visual Basic Help (2020-06-09 09:53:18.676780))
o Sub PutReleasePath(CATSafeArrayVariant iRelPath)

Sets the cache release paths.
Role: Sets the cache release paths in a symbolic format.

Parameters:

iRelPath
a CATSafeArrayVariant of CATBSTR.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_rel_path (tuple) –

Returns:

None

property released_voxel

Note

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

Returns or sets the released voxel parameter.
Role: Returns or sets the value of the released voxel parameter.
Returns:

float

set_activation_mode_lock(i_locked)

Note

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

Locks or unlocks the Cache Activation mode.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_cache_max_size_mo_lock(i_locked)

Note

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

Locks the paramater Cache maximum size.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_local_path_lock(i_locked)

Note

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

Locks or unlocks the cache local path parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_lod_mode_lock(i_locked)

Note

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

Locks or unlocks the LOD generation mode.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_release_path_lock(i_locked)

Note

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

Locks or unlocks the cache local path parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_released_voxel_lock(i_locked)

Note

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

Locks or unlocks the released voxel parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_size_control_lock(i_locked)

Note

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

Locks or unlocks the cache size control parameter.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_timestamp_mode_lock(i_locked)

Note

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

Locks or unlocks the timestamp control in cache.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

set_utc_time_format_lock(i_locked)

Note

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

Locks or unlocks the timestamp format.
Refer to SettingController for a detailed description.
Parameters:

i_locked (bool) –

Returns:

None

property size_control

Note

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

Return or sets the cache size control.
Role: Returns or sets the cache size control. The cache use this parameter
in conjunction with the maxixum allowed cache size. If it is turned off, the
cache size has no limit.
Returns:

bool

property timestamp_mode

Note

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

Retrieves or sets the timestamp control.
Role: If the timestamp control is turned on, the cache will verify if the
cached object is uptodate with the master object. If not a new cached view will
be generated.
If the timestamp control is turned off, the cache will consider that the
cached views are always uptodate with their master object.
Returns:

bool

property utc_time_format

Note

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

Retrieves or sets the the cache timestamp format.
Role: If the timestamp format is set to TRUE, then the time used used as
timestamp by the cache is expressed in UTC format (GMT), in the other case the
local time is used. The default format is local time.
Returns:

bool