All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAnalysisInterfaces Interface CATISamAnalysisGeneralSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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
GetAnalysisCacheMode(int&)
- Retrieves if we are handling Product Structure Cache Mode.
- o
GetAnalysisCacheModeInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetAnalysisLoadMode(int&)
- Retrieves if the pointed documents are automatically loaded.
- o
GetAnalysisLoadModeInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetAnalysisNamingAuto(int&)
- Tells if Automatic naming is activated.
- o
GetAnalysisNamingAutoInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetDefaultAnalysisFlag(int&)
- Retrieves if a default analysis Case will be created.
- o
GetDefaultAnalysisFlagInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetDefaultAnalysisTemplate(CATUnicodeString&)
- Retrieves the type of default analysis Case to create.
- o
GetDefaultAnalysisTemplateInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetViewAnalysisParameter(int&)
- Retrieves if the parameter set will be displayed in the feature tree.
- o
GetViewAnalysisParameterInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
GetViewAnalysisRelation(int&)
- Retrieves if the relation set will be displayed in the feature tree.
- o
GetViewAnalysisRelationInfo(CATSettingInfo*)
- Retrieves environment informations for the default flag.
- o
SetAnalysisCacheMode(int&)
- Sets up Product Structure Cache Mode handling.
- o
SetAnalysisCacheModeLock(unsigned char)
- Locks or unlocks the flag.
- o
SetAnalysisLoadMode(int&)
- Sets up if the pointed document are loaded.
- o
SetAnalysisLoadModeLock(unsigned char)
- Locks or unlocks the flag.
- o
SetAnalysisNamingAuto(int&)
- Sets the Automatic naming to be activated.
- o
SetAnalysisNamingAutoLock(unsigned char)
- Locks or unlocks the flag.
- o
SetDefaultAnalysisFlag(int&)
- Sets that a default analysis Case will be created.
- o
SetDefaultAnalysisFlagLock(unsigned char)
- Locks or unlocks the flag.
- o
SetDefaultAnalysisTemplate(CATUnicodeString&)
- Sets up a type of default analysis Case to create.
- o
SetDefaultAnalysisTemplateLock(unsigned char)
- Locks or unlocks the flag.
- o
SetViewAnalysisParameter(int&)
- Sets up if the parameter set will be displayed in the feature tree.
- o
SetViewAnalysisParameterLock(unsigned char)
- Locks or unlocks the flag.
- o
SetViewAnalysisRelation(int&)
- Sets up if the relation set will be displayed in the feature tree.
- o
SetViewAnalysisRelationLock(unsigned char)
- Locks or unlocks the flag.
Methods
o GetAnalysisCacheMode
public virtual HRESULT GetAnalysisCacheMode( | int& | oAllowed)=0 |
-
Retrieves if we are handling Product Structure Cache Mode.
Legal values:
1 : Cache Mode is handled.
0 : Cache Mode is not handled.
o GetAnalysisCacheModeInfo
-
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 HRESULT GetAnalysisLoadMode( | int& | oAllowed)=0 |
-
Retrieves if the pointed documents are automatically loaded.
Legal values:
1 : pointed documents are not automatically loaded.
0 : pointed documents are automatically loaded.
o GetAnalysisLoadModeInfo
-
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 HRESULT GetAnalysisNamingAuto( | int& | oAllowed)=0 |
-
Tells if Automatic naming is activated.
Legal values:
1 : Automatic Naming is activated.
0 : Automatic Naming is not activated.
o GetAnalysisNamingAutoInfo
-
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 HRESULT GetDefaultAnalysisFlag( | int& | oAllowed)=0 |
-
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 GetDefaultAnalysisFlagInfo
-
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
-
Retrieves the type of default analysis Case to create.
- Parameters:
-
- oTemplate
- The Case type.
o GetDefaultAnalysisTemplateInfo
-
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 HRESULT GetViewAnalysisParameter( | int& | oAllowed)=0 |
-
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 GetViewAnalysisParameterInfo
-
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 HRESULT GetViewAnalysisRelation( | int& | oAllowed)=0 |
-
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 GetViewAnalysisRelationInfo
-
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 SetAnalysisCacheMode
public virtual HRESULT SetAnalysisCacheMode( | const int& | oAllowed)=0 |
-
Sets up Product Structure Cache Mode handling.
Legal values:
1 : Cache Mode is handled.
0 : Cache Mode is not handled.
o SetAnalysisCacheModeLock
public virtual HRESULT SetAnalysisCacheModeLock( | unsigned char | iLocked)= 0 |
-
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 HRESULT SetAnalysisLoadMode( | const int& | oAllowed)=0 |
-
Sets up if the pointed document are loaded.
Legal values:
1 : pointed documents are not automatically loadedd.
0 : pointed documents are automatically loaded.
o SetAnalysisLoadModeLock
public virtual HRESULT SetAnalysisLoadModeLock( | unsigned char | iLocked)= 0 |
-
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 HRESULT SetAnalysisNamingAuto( | const int& | iAllowed)=0 |
-
Sets the Automatic naming to be activated.
Legal values:
1 : Automatic Naming is activated.
0 : Automatic Naming is not activated.
o SetAnalysisNamingAutoLock
public virtual HRESULT SetAnalysisNamingAutoLock( | unsigned char | iLocked)= 0 |
-
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 HRESULT SetDefaultAnalysisFlag( | const int& | iAllowed)=0 |
-
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 SetDefaultAnalysisFlagLock
public virtual HRESULT SetDefaultAnalysisFlagLock( | unsigned char | iLocked)= 0 |
-
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
-
Sets up a type of default analysis Case to create.
- Parameters:
-
- iTemplate
- The Case type.
o SetDefaultAnalysisTemplateLock
public virtual HRESULT SetDefaultAnalysisTemplateLock( | unsigned char | iLocked)= 0 |
-
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 HRESULT SetViewAnalysisParameter( | const int& | oAllowed)=0 |
-
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 SetViewAnalysisParameterLock
public virtual HRESULT SetViewAnalysisParameterLock( | unsigned char | iLocked)= 0 |
-
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 HRESULT SetViewAnalysisRelation( | const int& | oAllowed)=0 |
-
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.
o SetViewAnalysisRelationLock
public virtual HRESULT SetViewAnalysisRelationLock( | unsigned char | iLocked)= 0 |
-
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
This object is included in the file: CATISamAnalysisGeneralSettingAtt.h
If needed, your Imakefile.mk should include the module: CATAnalysisInterface