pycatia.system_interfaces.general_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.general_statistics_setting_att.GeneralStatisticsSettingAtt(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

GeneralStatisticsSettingAtt

Interface for General statistic Controller.

Role: the General statistics controller is a generic interface for all the

thematics. One should never use it as a statistics thematic.

property activation

Note

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

o Property Activation() As boolean

Returns or sets the activation state of the statistics

thematic.

Role: Returns or sets the value of statistics thematic activation.

Returns:

bool

property cpus

Note

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

o Property CPUS() As boolean

Returns or sets the state ot the cpu time field.

Role: Returns or sets the state ot the cpu time field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

property cumulation_mode

Note

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

o Property CumulationMode() As boolean

Returns or sets the cumulation state of the statistics

thematic.

Role: Returns or sets the value of statistics thematic cumulation.

Returns:

bool

property date_format

Note

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

o Property DateFormat() As CATBSTR

Returns or sets the state ot the date format field.

Role: Returns or sets the state ot the date format field.

Parameters:

iDateFormat

Legal values:

StandardDate : default date format (Mon Jan 1 08:00.00 2000)

NumericalDate: numerical date

format(2000.001.08.00.00)

NumericalDateMilliecond: numerical date

format(2000.001.08.00.00.000)

Returns:

str

property elps

Note

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

o Property ELPS() As boolean

Returns or sets the state ot the elapsed time field.

Role: Returns or sets the state ot the elapsed time field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

get_format_mode(flag)

Note

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

o Func GetFormatMode(long flag) As boolean

Returns the format mode of the statistics thematic.

Role: Returns or sets the format mode of the statistics

thematic.

Parameters:

oFormatMode

Legal values:

TRUE : the thematic output is formated (field=”value”).

FALSE: the thematic output is not formated

(“value”).

Parameters:

flag (int) –

Returns:

bool

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 general statistics

parameters.

Refer to SettingController for a detailed description.

Parameters:

• admin_level (str) –

• o_locked (str) –

Returns:

None

property host

Note

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

o Property HOST() As boolean

Returns or sets the state ot the host name field.

Role: Returns or sets the state ot the host name field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

property output

Note

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

o Property Output() As CATBSTR

Returns or sets the output format of the statistics

thematic.

Role: Returns or sets the output format of the statistics

thematic.

Parameters:

oOutputType

Legal values:

File :statistics are outputed in a file

Console: statistics are outputed on the console (if

available)

Returns:

str

property output_file

Note

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

o Property OutputFile() As CATBSTR

Returns or sets the path of the statistics thematic file.

Role: Returns or sets the path of the statistics thematic file.

Returns:

str

property output_format

Note

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

o Property OutputFormat() As CATBSTR

Returns or sets the state ot the output format field.

Role: Returns or sets the state ot the output format

field.

Parameters:

iOutputFormat

Legal values:

StandardOutput: default format

NoThematics : the thematic name is not repeated on each line

Returns:

str

property rtim

Note

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

o Property RTIM() As boolean

Returns or sets the state ot the response time field.

Role: Returns or sets the state ot the response time

field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

set_format_mode(i_format_mode, flag)

Note

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

o Sub SetFormatMode(boolean iFormatMode,

long flag)

Sets the format mode of the statistics thematic.

Role: Returns or sets the format mode of the statistics

thematic.

Parameters:

iFormatMode

Legal values:

TRUE : the thematic output is formated (field=”value”).

FALSE: the thematic output is not formated

(“value”).

Parameters:

• i_format_mode (bool) –

• flag (int) –

Returns:

None

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 general statistics parameters.

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

property them

Note

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

o Property THEM() As boolean

Returns or sets the state ot the thematic field.

Role: Returns or sets the state ot the thematic field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

property time

Note

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

o Property TIME() As boolean

Returns or sets the state ot the time and date field.

Role: Returns or sets the state ot the time and date

field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

property time_unit

Note

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

o Property TimeUnit() As CATBSTR

Returns or sets the state ot the time unit field.

Role: Returns or sets the state ot the time unit field.

Parameters:

iTimeUnit

Legal values:

Second : durations are in seconds

Millisecond: durations are in milliseconds

Returns:

str

property upid

Note

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

o Property UPID() As boolean

Returns or sets the state ot the user pid field.

Role: Returns or sets the state ot the user pid field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool

property user

Note

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

o Property USER() As boolean

Returns or sets the state ot the user name field.

Role: Returns or sets the state ot the user name field.

Parameters:

oStatus

Legal values:

TRUE : the field is activated

FALSE: the field is not activated

Returns:

bool