pycatia.system_interfaces.global_statistics_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.global_statistics_setting_att.GlobalStatisticsSettingAtt(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
GlobalStatisticsSettingAtt

Interface for Global statistic Controller
Role: the global statistics controller manages the values of all or only a part
of the attributes available for all the statistics thematics.
property buffer_size

Note

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

Returns or sets the size of buffer.
Role: Returns or sets the size of the buffer.

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

int

property copy_directory

Note

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

Returns or sets the path of the copy directory.
Role: Returns or sets the path of the directory where the copy files are
located.

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

str

get_thematics_parameter_info(admin_level, o_locked)

Note

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

Retrieves environment informations for the global statistics
parameters.
Refer to SettingController for a detailed description.
Parameters:
  • admin_level (str) –

  • o_locked (str) –

Returns:

None

property max_copy_file

Note

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

Returns or sets the maximum number of copy files.
Role: Returns or sets the value of the maximum number of statistics files
copies.

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

int

property max_size_per_file

Note

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

Returns or sets the maximum size per file.
Role: Returns or sets the value of the maximum size of statistics
files.

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

int

set_thematics_parameter_lock(i_locked)

Note

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

Locks or unlocks the global statistics parameters.
Role:Locks or unlocks the global statistics parameters.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

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

i_locked (bool) –

Returns:

None