All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisInterfaces Interface CATISamAnalysisGeneralSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamAnalysisGeneralSettingAtt
Interface to handle the Analysis & Simulation "GeneralSetting".
Method Index
- o
GetAnalysisCacheModeInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetAnalysisCacheMode(int&)
- Retrieves if we are handling Product Structure Cache Mode.
- o
GetAnalysisLoadModeInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetAnalysisLoadMode(int&)
- Retrieves if the pointed documents are automatically loaded.
- o
GetAnalysisNamingAutoInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetAnalysisNamingAuto(int&)
- Tells if Automatic naming is activated.
- o
GetDefaultAnalysisFlagInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetDefaultAnalysisFlag(int&)
- Retrieves if a default analysis Case will be created.
- o
GetDefaultAnalysisTemplateInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetDefaultAnalysisTemplate(CATUnicodeString&)
- Retrieves the type of default analysis Case to create.
- o
GetViewAnalysisParameterInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetViewAnalysisParameter(int&)
- Retrieves if the parameter set will be displayed in the feature tree.
- o
GetViewAnalysisRelationInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetViewAnalysisRelation(int&)
- Retrieves if the relation set will be displayed in the feature tree.
- o
SetAnalysisCacheModeLock(unsigned char)
- Locks or unlocks the flag.
- o
SetAnalysisCacheMode(int&)
- Sets up Product Structure Cache Mode handling.
- o
SetAnalysisLoadModeLock(unsigned char)
- Locks or unlocks the flag.
- o
SetAnalysisLoadMode(int&)
- Sets up if the pointed document are loaded.
- o
SetAnalysisNamingAutoLock(unsigned char)
- Locks or unlocks the flag.
- o
SetAnalysisNamingAuto(int&)
- Sets the Automatic naming to be activated.
- o
SetDefaultAnalysisFlagLock(unsigned char)
- Locks or unlocks the flag.
- o
SetDefaultAnalysisFlag(int&)
- Sets that a default analysis Case will be created.
- o
SetDefaultAnalysisTemplateLock(unsigned char)
- Locks or unlocks the flag.
- o
SetDefaultAnalysisTemplate(CATUnicodeString&)
- Sets up a type of default analysis Case to create.
- o
SetViewAnalysisParameterLock(unsigned char)
- Locks or unlocks the flag.
- o
SetViewAnalysisParameter(int&)
- Sets up if the parameter set will be displayed in the feature tree.
- o
SetViewAnalysisRelationLock(unsigned char)
- Locks or unlocks the flag.
- o
SetViewAnalysisRelation(int&)
- Sets up if the relation set will be displayed in the feature tree.
Methods
o GetAnalysisCacheModeInfo
| public virtual GetAnalysisCacheModeInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAnalysisCacheMode
| public virtual GetAnalysisCacheMode( | | oAllowed) |
-
Retrieves if we are handling Product Structure Cache Mode.
Legal values:
1 : Cache Mode is handled.
0 : Cache Mode is not handled.
o GetAnalysisLoadModeInfo
| public virtual GetAnalysisLoadModeInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAnalysisLoadMode
| public virtual GetAnalysisLoadMode( | | oAllowed) |
-
Retrieves if the pointed documents are automatically loaded.
Legal values:
1 : pointed documents are not automatically loaded.
0 : pointed documents are automatically loaded.
o GetAnalysisNamingAutoInfo
| public virtual GetAnalysisNamingAutoInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAnalysisNamingAuto
| public virtual GetAnalysisNamingAuto( | | oAllowed) |
-
Tells if Automatic naming is activated.
Legal values:
1 : Automatic Naming is activated.
0 : Automatic Naming is not activated.
o GetDefaultAnalysisFlagInfo
| public virtual GetDefaultAnalysisFlagInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDefaultAnalysisFlag
| public virtual GetDefaultAnalysisFlag( | | oAllowed) |
-
Retrieves if a default analysis Case will be created.
Legal values:
1 : No default case is set up.
0 : A default case is set up.
o GetDefaultAnalysisTemplateInfo
| public virtual GetDefaultAnalysisTemplateInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDefaultAnalysisTemplate
| public virtual GetDefaultAnalysisTemplate( | | oTemplate) |
-
Retrieves the type of default analysis Case to create.
- Parameters:
-
- oTemplate
- The Case type.
o GetViewAnalysisParameterInfo
| public virtual GetViewAnalysisParameterInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewAnalysisParameter
| public virtual GetViewAnalysisParameter( | | oAllowed) |
-
Retrieves if the parameter set will be displayed in the feature tree.
Legal values:
1 : The parameter set is shown.
0 : The parameter set is hidden.
o GetViewAnalysisRelationInfo
| public virtual GetViewAnalysisRelationInfo( | | oInfo) |
-
Retrieves environment informations for the default flag.
Role:Retrieves the state of the default flag in the current environment.
- Parameters:
-
- AdminLevel
-
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
- oLocked
- Indicates if the parameter has been locked.
- oModified
- Indicates if the parameter has been explicitly modified or remain to the administrated value.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewAnalysisRelation
| public virtual GetViewAnalysisRelation( | | oAllowed) |
-
Retrieves if the relation set will be displayed in the feature tree.
Legal values:
1 : The relation set is shown.
0 : The relation set is hidden.
o SetAnalysisCacheModeLock
| public virtual SetAnalysisCacheModeLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetAnalysisCacheMode
| public virtual SetAnalysisCacheMode( | const | oAllowed) |
-
Sets up Product Structure Cache Mode handling.
Legal values:
1 : Cache Mode is handled.
0 : Cache Mode is not handled.
o SetAnalysisLoadModeLock
| public virtual SetAnalysisLoadModeLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetAnalysisLoadMode
| public virtual SetAnalysisLoadMode( | const | oAllowed) |
-
Sets up if the pointed document are loaded.
Legal values:
1 : pointed documents are not automatically loadedd.
0 : pointed documents are automatically loaded.
o SetAnalysisNamingAutoLock
| public virtual SetAnalysisNamingAutoLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetAnalysisNamingAuto
| public virtual SetAnalysisNamingAuto( | const | iAllowed) |
-
Sets the Automatic naming to be activated.
Legal values:
1 : Automatic Naming is activated.
0 : Automatic Naming is not activated.
o SetDefaultAnalysisFlagLock
| public virtual SetDefaultAnalysisFlagLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetDefaultAnalysisFlag
| public virtual SetDefaultAnalysisFlag( | const | iAllowed) |
-
Sets that a default analysis Case will be created.
Legal values:
1 : No default case is set up.
0 : A default case is set up.
o SetDefaultAnalysisTemplateLock
| public virtual SetDefaultAnalysisTemplateLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetDefaultAnalysisTemplate
| public virtual SetDefaultAnalysisTemplate( | const | iTemplate) |
-
Sets up a type of default analysis Case to create.
- Parameters:
-
- iTemplate
- The Case type.
o SetViewAnalysisParameterLock
| public virtual SetViewAnalysisParameterLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetViewAnalysisParameter
| public virtual SetViewAnalysisParameter( | const | oAllowed) |
-
Sets up if the parameter set will be displayed in the feature tree.
Legal values:
1 : The parameter set is shown.
0 : The parameter set is hidden.
o SetViewAnalysisRelationLock
| public virtual SetViewAnalysisRelationLock( | | iLocked) |
-
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is
possible in the current administrated. In user mode this method
will always return E_FAIL.
- 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
o SetViewAnalysisRelation
| public virtual SetViewAnalysisRelation( | const | oAllowed) |
-
Sets up if the relation set will be displayed in the feature tree.
Legal values:
1 : The relation set is shown.
0 : The relation set is hidden.
This object is included in the file: CATISamAnalysisGeneralSettingAtt.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface