All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

GeneralStatisticsSettingAtt (Object)

Interface for General statistic Controler.

Role: the General statistics controler is a generic interface for all the thematics. One should never use it as a statistics thematic.

Property Index

Activation
Returns or sets the activation state of the statistics thematic.
CPUS
Returns or sets the state ot the cpu time field.
CumulationMode
Returns or sets the cumulation state of the statistics thematic.
DateFormat
Returns or sets the state ot the date format field.
ELPS
Returns or sets the state ot the elapsed time field.
HOST
Returns or sets the state ot the host name field.
OutputFile
Returns or sets the path of the statistics thematic file.
OutputFormat
Returns or sets the state ot the output format field.
Output
Returns or sets the output format of the statistics thematic.
RTIM
Returns or sets the state ot the response time field.
THEM
Returns or sets the state ot the thematic field.
TIME
Returns or sets the state ot the time and date field.
TimeUnit
Returns or sets the state ot the time unit field.
UPID
Returns or sets the state ot the user pid field.
USER
Returns or sets the state ot the user name field.

Method Index

GetFormatMode
Returns the format mode of the statistics thematic.
GetThematicsParameterInfo
Retrieves environment informations for the general statistics parameters.
SetFormatMode
Sets the format mode of the statistics thematic.
SetThematicsParameterLock
Locks or unlocks the general statistics parameters.

Properties


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

Methods


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").
o Func GetThematicsParameterInfo(CATBSTR AdminLevel,
CATBSTR oLocked) As boolean
Retrieves environment informations for the general statistics parameters.
Refer to SettingController for a detailled description.
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").
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

Copyright © 2003, Dassault Systèmes. All rights reserved.