All Frameworks  Class Hierarchy  This Framework  Indexes   

System Interface CATISysGeneralStatisticsSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISysGeneralStatisticsSettingAtt

Interface to handle the parameters of all the statistics thematics.
Role: This interface is implemented by a component which contains all the methods and variables available for all the statistics thematics. One should never use it as a statistics thematic.
This interface defines:


Method Index


o GetActivation(int*)
Retrieves the activation state of the thematic.
o GetCPUS(CATBoolean&)
Retrieves the activation state of the cpu time field.
o GetCumulationMode(int*)
Retrieves the cumulation state of the thematic.
o GetDateFormat(CATSysStatisticsDateFormat&)
Retrieves the activation state of the date format field.
o GetELPS(CATBoolean&)
Retrieves the activation state of the elapsed time field.
o GetFormatMode(int*,int)
Retrieves the output format mode of the thematic.
o GetHOST(CATBoolean&)
Retrieves the activation state of the host name field.
o GetOutputFile(CATUnicodeString*)
Retrieves the output file of the thematic.
o GetOutputFormat(CATSysStatisticsOutputFormat&)
Retrieves the activation state of the output format field.
o GetOutputSettingInfo(CATSettingInfo&)
Retrieves the CATSettingInfo of the thematic.
o GetOutput(int*)
Retrieves the output format of the thematic.
o GetRTIM(CATBoolean&)
Retrieves the activation state of the response time field.
o GetTHEM(CATBoolean&)
Retrieves the activation state of the thematic name field.
o GetTIME(CATBoolean&)
Retrieves the activation state of the date and time field.
o GetThematicsParameterInfo(CATSettingInfo*)
Retrieves environment informations for the general statistics parameters.
o GetTimeUnit(CATSysStatisticsTimeUnit&)
Retrieves the activation state of the time unit field.
o GetUPID(CATBoolean&)
Retrieves the activation state of the user pid field.
o GetUSER(CATBoolean&)
Retrieves the activation state of the user name field.
o SetActivation(int)
Sets the activation state of the thematic.
o SetCPUS(CATBoolean&)
Sets the activation state of the cpu time field.
o SetCumulationMode(int)
Sets the value of the cumulation state of the thematic.
o SetDateFormat(CATSysStatisticsDateFormat&)
Sets the activation state of the date format field.
o SetELPS(CATBoolean&)
Sets the activation state of the elapsed time field.
o SetFormatMode(int,int)
Sets the output format mode of the thematic.
o SetHOST(CATBoolean&)
Sets the activation state of the host name field.
o SetOutputFile(CATUnicodeString)
Sets the output file of the thematic.
o SetOutputFormat(CATSysStatisticsOutputFormat&)
Sets the activation state of the thematic name field.
o SetOutput(int)
Sets the output format of the thematic.
o SetRTIM(CATBoolean&)
Sets the activation state of the response time field.
o SetTHEM(CATBoolean&)
Sets the activation state of the thematic name field.
o SetTIME(CATBoolean&)
Sets the activation state of the date and time field.
o SetThematicsParameterLock(unsigned char)
Locks or unlocks the general statistics parameters.
o SetTimeUnit(CATSysStatisticsTimeUnit&)
Sets the activation state of the time unit field.
o SetUPID(CATBoolean&)
Sets the activation state of the user pid field.
o SetUSER(CATBoolean&)
Sets the activation state of the user name field.

Methods


o GetActivation
public virtual GetActivation( oActivatationState)
Retrieves the activation state of the thematic.
Role: Retrieves the activation state of the thematic
Parameters:
oActivatationState
Legal values:
1 : activated
0 : not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetCPUS
public virtual GetCPUS( oStatus)
Retrieves the activation state of the cpu time field.
Role: Retrieves the activation state of the cpu time field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetCumulationMode
public virtual GetCumulationMode( oCumulative)
Retrieves the cumulation state of the thematic.
Role: Retrieves the cumulation state of the thematic
Parameters:
oCumulative
Legal values:
1 : cumulated
0 : not cumulated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetDateFormat
public virtual GetDateFormat( DateFormat)
Retrieves the activation state of the date format field.
Role: Retrieves the activation state of the date format field
Parameters:
oStatus
Legal values:
StandardDate : default date format
NumericalDate: numerical date format
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetELPS
public virtual GetELPS( oStatus)
Retrieves the activation state of the elapsed time field.
Role: Retrieves the activation state of the elapsed time field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetFormatMode
public virtual GetFormatMode( oFormatMode,
flag=0)
Retrieves the output format mode of the thematic.
Role: Retrieves the output format mode of the thematic.
Parameters:
oFormatMode
Legal values:
1 : formated
0 : not formated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetHOST
public virtual GetHOST( oStatus)
Retrieves the activation state of the host name field.
Role: Retrieves the activation state of the host name field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputFile
public virtual GetOutputFile( oOutputFile)
Retrieves the output file of the thematic.
Role: Retrieves the output file of the thematic.
Parameters:
oOutputFile
Name of the output file
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputFormat
public virtual GetOutputFormat( iOutputFormat)
Retrieves the activation state of the output format field.
Role: Retrieves the activation state of the thematic name field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutputSettingInfo
public virtual GetOutputSettingInfo( oCATSettingInfo)
Retrieves the CATSettingInfo of the thematic.
Role: Retrieves the CATSettingInfo of the thematic.(no longer used)
Parameters:
oCATSettingInfo
CATSettingInfo returned
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetOutput
public virtual GetOutput( oOutputType)
Retrieves the output format of the thematic.
Role: Retrieves the output format of the thematic.
Parameters:
oOutputType
Legal values:
1 : console (if available)
2 : file
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetRTIM
public virtual GetRTIM( oStatus)
Retrieves the activation state of the response time field.
Role: Retrieves the activation state of the response time field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTHEM
public virtual GetTHEM( oStatus)
Retrieves the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTIME
public virtual GetTIME( oStatus)
Retrieves the activation state of the date and time field.
Role: Retrieves the activation state of the date and time field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetThematicsParameterInfo
public virtual GetThematicsParameterInfo( oCATSettingInfo)
Retrieves environment informations for the general statistics parameters.
Role:Retrieves the state of statistics parameters in the current environment.
Parameters:
oCATSettingInfo
CATSettingInfo returned
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetTimeUnit
public virtual GetTimeUnit( iTimeUnit)
Retrieves the activation state of the time unit field.
Role: Retrieves the activation state of the time unit field
Parameters:
iTimeUnit
Legal values:
Millisecond : durations in milliseconds
Second : durations in seconds
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetUPID
public virtual GetUPID( oStatus)
Retrieves the activation state of the user pid field.
Role: Retrieves the activation state of the user pid field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o GetUSER
public virtual GetUSER( oStatus)
Retrieves the activation state of the user name field.
Role: Retrieves the activation state of the user name field
Parameters:
oStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetActivation
public virtual SetActivation( iActivationState)
Sets the activation state of the thematic.
Role: Retrieves the activation state of the thematic
Parameters:
oActivatationState
Legal values:
1 : activated
0 : not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetCPUS
public virtual SetCPUS( const iStatus)
Sets the activation state of the cpu time field.
Role: Retrieves the activation state of the cpu time field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetCumulationMode
public virtual SetCumulationMode( oCumulative)
Sets the value of the cumulation state of the thematic.
Role: Sets the cumulation state of the thematic
Parameters:
oCumulative
Legal values:
1 : cumulated
0 : not cumulated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetDateFormat
public virtual SetDateFormat( DateFormat)
Sets the activation state of the date format field.
Role: Retrieves the activation state of the date format field
Parameters:
iStatus
Legal values:
StandardDate : default date format
NumericalDate: numerical date format
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetELPS
public virtual SetELPS( const iStatus)
Sets the activation state of the elapsed time field.
Role: Retrieves the activation state of the elapsed time field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetFormatMode
public virtual SetFormatMode( iFormatMode,
flag=0)
Sets the output format mode of the thematic.
Role: Sets the output format mode of the thematic
Parameters:
iFormatMode
Legal values:
1 : formated
0 : not formated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetHOST
public virtual SetHOST( const iStatus)
Sets the activation state of the host name field.
Role: Retrieves the activation state of the host name field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutputFile
public virtual SetOutputFile( iOutputFile)
Sets the output file of the thematic.
Role: Sets the output file of the thematic
Parameters:
iOutputFile
Name of the output file
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutputFormat
public virtual SetOutputFormat( iOutputFormat)
Sets the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetOutput
public virtual SetOutput( iOutputType)
Sets the output format of the thematic.
Role: Sets the output format of the thematic
Parameters:
iOutputType
Legal values:
1 : console (if available)
2 : file
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetRTIM
public virtual SetRTIM( const iStatus)
Sets the activation state of the response time field.
Role: Retrieves the activation state of the response time field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetTHEM
public virtual SetTHEM( const iStatus)
Sets the activation state of the thematic name field.
Role: Retrieves the activation state of the thematic name field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetTIME
public virtual SetTIME( const iStatus)
Sets the activation state of the date and time field.
Role: Retrieves the activation state of the date and time field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetThematicsParameterLock
public virtual SetThematicsParameterLock( iLock)
Locks or unlocks the general statistics parameters.
Role:Locks or unlocks the statistics parameters.
Parameters:
iLock
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
o SetTimeUnit
public virtual SetTimeUnit( iTimeUnit)
Sets the activation state of the time unit field.
Role: Retrieves the activation state of the time unit field
Parameters:
iTimeUnit
Legal values:
Millisecond : durations in milliseconds
Second : durations in seconds
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetUPID
public virtual SetUPID( const iStatus)
Sets the activation state of the user pid field.
Role: Retrieves the activation state of the user pid field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure
o SetUSER
public virtual SetUSER( const iStatus)
Sets the activation state of the user name field.
Role: Retrieves the activation state of the user name field
Parameters:
iStatus
Legal values:
TRUE : activated
FALSE: not activated
Returns:
Legal values:
S_OK : on Success
E_FAIL: on Failure

This object is included in the file: CATISysGeneralStatisticsSettingAtt.h
If needed, your Imakefile.mk should include the module: JS0GROUP

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