All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATAssemblyInterfaces Interface CATIAsmGeneralSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIAsmGeneralSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAsmGeneralSettingAtt
Interface to modify Assembly Design options.
Role: This interface may be used to read
or modify the options of Assembly Design.
Method Index
- o
GetAutoSwitchToDesignMode(AutoSwitchToDesignMode&)
- Retrieves the implicit switch from visualization mode to design mode option.
- o
GetAutoSwitchToDesignModeInfo(CATSettingInfo*)
- Retrieves the state of the implicit switch from visualization mode to design mode option.
- o
GetAutoUpdateMode(UpdateMode&)
- Retrieves the automatic update option.
- o
GetAutoUpdateModeInfo(CATSettingInfo*)
- Retrieves the state of the automatic update option.
- o
GetMoveWithFixTExtendMode(ExtendMoveToFixT&)
- Retrieves the option managing the extension of a move
to the components involved in a FixTogether.
- o
GetMoveWithFixTExtendModeInfo(CATSettingInfo*)
- Retrieves the state of the the option managing the extension of a move
to the components involved in a FixTogether.
- o
GetUpdateStatusMode(UpdateStatusComputeMode&)
- Retrieves the update status computation option.
- o
GetUpdateStatusModeInfo(CATSettingInfo*)
- Retrieves the state of the update status computation option.
- o
SetAutoSwitchToDesignMode(AutoSwitchToDesignMode)
- Sets the implicit switch from visualization mode to design mode option.
- o
SetAutoSwitchToDesignModeLock(unsigned char)
- Locks or unlocks the implicit switch from visualization mode to design mode option.
- o
SetAutoUpdateMode(UpdateMode)
- Sets the automatic update option.
- o
SetAutoUpdateModeLock(unsigned char)
- Locks or unlocks the automatic update option.
- o
SetMoveWithFixTExtendMode(ExtendMoveToFixT)
- Sets the the option managing the extension of a move
to the components involved in a FixTogether.
- o
SetMoveWithFixTExtendModeLock(unsigned char)
- Locks or unlocks the the option managing the extension of a move
to the components involved in a FixTogether.
- o
SetUpdateStatusMode(UpdateStatusComputeMode)
- Sets the update status computation option.
- o
SetUpdateStatusModeLock(unsigned char)
- Locks or unlocks the update status computation option.
Enumerated Type Index
- o
AutoSwitchToDesignMode
- Option managing the implicit switch from visualization mode to design mode.
- o
ExtendMoveToFixT
- Option managing the extension of a move
to the components involved in a FixTogether.
- o
UpdateMode
- Update command mode.
- o
UpdateStatusComputeMode
- Real update status computation mode.
Methods
o GetAutoSwitchToDesignMode
public virtual HRESULT GetAutoSwitchToDesignMode( | AutoSwitchToDesignMode& | oAutoSwitchToDM)= 0 |
-
Retrieves the implicit switch from visualization mode to design mode option.
Note that this option is useful only when the Cache option is activated
- Parameters:
-
- oAutoSwitchToDM
- Legal values:
AutoSwitchAvailable : Automatic switch to design mode available
AutoSwitchUnavailable : Automatic switch to design mode unavailable
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetAutoSwitchToDesignModeInfo
-
Retrieves the state of the implicit switch from visualization mode to design mode option.
- Parameters:
-
- oInfo
- Address of the
CATSettingInfo object.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetAutoUpdateMode
public virtual HRESULT GetAutoUpdateMode( | UpdateMode& | oAutoUpdateMode)= 0 |
-
Retrieves the automatic update option.
- Parameters:
-
- oAutoUpdateMode
- Legal values:
ManualUpdate : Manual update mode
AutomaticUpdate : Automatic update mode
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetAutoUpdateModeInfo
-
Retrieves the state of the automatic update option.
- Parameters:
-
- oInfo
- Address of the
CATSettingInfo object.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetMoveWithFixTExtendMode
public virtual HRESULT GetMoveWithFixTExtendMode( | ExtendMoveToFixT& | oMvFixTExtendMode)= 0 |
-
Retrieves the option managing the extension of a move
to the components involved in a FixTogether.
- Parameters:
-
- oMvFixTExtendMode
- Legal values:
NeverExtendMove : Never extend move to all component involved in a FixTogether
AskIfExtendMove : Ask question to extend move to all component involved in a FixTogether
AlwaysExtendMove : allways extend move to all component involved in a FixTogether
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetMoveWithFixTExtendModeInfo
-
Retrieves the state of the the option managing the extension of a move
to the components involved in a FixTogether.
- Parameters:
-
- oInfo
- Address of the
CATSettingInfo object.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetUpdateStatusMode
public virtual HRESULT GetUpdateStatusMode( | UpdateStatusComputeMode& | oUpdateStatusMode)=0 |
-
Retrieves the update status computation option.
Note that this option is useful only when the Cache option is activated
- Parameters:
-
- oUpdateStatusMode
- Legal values:
ManualCompute : At open the update status is unknown
AutomaticCompute : Additional data are being loaded at open
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o GetUpdateStatusModeInfo
-
Retrieves the state of the update status computation option.
- Parameters:
-
- oInfo
- Address of the
CATSettingInfo object.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetAutoSwitchToDesignMode
public virtual HRESULT SetAutoSwitchToDesignMode( | const AutoSwitchToDesignMode | iAutoSwitchToDM)= 0 |
-
Sets the implicit switch from visualization mode to design mode option.
Note that this option is useful only when the Cache option is activated
- Parameters:
-
- iAutoSwitchToDM
- Legal values:
AutoSwitchAvailable : Automatic switch to design mode available
AutoSwitchUnavailable : Automatic switch to design mode unavailable
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetAutoSwitchToDesignModeLock
public virtual HRESULT SetAutoSwitchToDesignModeLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the implicit switch from visualization mode to design mode option.
- Parameters:
-
- iLock
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetAutoUpdateMode
public virtual HRESULT SetAutoUpdateMode( | const UpdateMode | iAutoUpdateMode)= 0 |
-
Sets the automatic update option.
- Parameters:
-
- iAutoUpdateMode
- Legal values:
ManualUpdate : Manual update mode
AutomaticUpdate : Automatic update mode
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetAutoUpdateModeLock
public virtual HRESULT SetAutoUpdateModeLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the automatic update option.
- Parameters:
-
- iLock
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetMoveWithFixTExtendMode
public virtual HRESULT SetMoveWithFixTExtendMode( | const ExtendMoveToFixT | iMvFixTExtendMode)= 0 |
-
Sets the the option managing the extension of a move
to the components involved in a FixTogether.
- Parameters:
-
- iMvFixTExtendMode
- Legal values:
NeverExtendMove : Never extend move to all component involved in a FixTogether
AskIfExtendMove : Ask question to extend move to all component involved in a FixTogether
AlwaysExtendMove : allways extend move to all component involved in a FixTogether
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetMoveWithFixTExtendModeLock
public virtual HRESULT SetMoveWithFixTExtendModeLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the the option managing the extension of a move
to the components involved in a FixTogether.
- Parameters:
-
- iLock
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetUpdateStatusMode
public virtual HRESULT SetUpdateStatusMode( | const UpdateStatusComputeMode | iUpdateStatusMode)=0 |
-
Sets the update status computation option.
Note that this option is useful only when the Cache option is activated
- Parameters:
-
- iUpdateStatusMode
- Legal values:
ManualCompute : At open the update status is unknown
AutomaticCompute : Additional data are being loaded at open
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
o SetUpdateStatusModeLock
public virtual HRESULT SetUpdateStatusModeLock( | unsigned char | iLock)=0 |
-
Locks or unlocks the update status computation option.
- Parameters:
-
- iLock
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0 : to unlock the parameter.
- Returns:
-
- S_OK
- on success
- E_FAIL
- on failure
Enumerated Types
o AutoSwitchToDesignMode
-
enum AutoSwitchToDesignMode {
AutoSwitchAvailable,
AutoSwitchUnavailable
}
Option managing the implicit switch from visualization mode to design mode.
The mode is used as input parameter in
SetAutoSwitchToDesignMode and as output parameter in
GetAutoSwitchToDesignMode
- Parameters:
-
- AutoSwitchUnavailable
- No automatic switch to design mode.
- AutoSwitchAvailable
- Parts are being switched to necessary design mode when needed.
o ExtendMoveToFixT
-
enum ExtendMoveToFixT {
NeverExtendMove,
AskIfExtendMove,
AlwaysExtendMove
}
Option managing the extension of a move
to the components involved in a FixTogether.
The mode is used as input parameter in
SetMoveWithFixTExtendMode and as output parameter in
GetMoveWithFixTExtendMode
- Parameters:
-
- NeverExtendMove
- Never extend move to all components involved in a FixTogether
- AskIfExtendMove
- Ask question to extend move to all component involved in a FixTogether
- AlwaysExtendMove
- always extend move to all component involved in a FixTogether
o UpdateMode
-
enum UpdateMode {
ManualUpdate,
AutomaticUpdate
}
Update command mode.
The mode is used as input parameter in
SetAutoUpdateMode and as output parameter in
GetAutoUpdateMode
- Parameters:
-
- ManualUpdate
- The user will need to launch the Update command.
- AutomaticUpdate
- The Update command will be automatically launched.
o UpdateStatusComputeMode
-
enum UpdateStatusComputeMode {
ManualCompute,
AutomaticCompute
}
Real update status computation mode.
The mode is used as input parameter in
SetUpdateStatusMode and as output parameter in
GetUpdateStatusMode
- Parameters:
-
- ManualCompute
- The user chooses when he want to compute the exact Update status.
- AutomaticCompute
- Additional data are being loaded to compute an exact Update status.
This object is included in the file: CATIAsmGeneralSettingAtt.h
If needed, your Imakefile.mk should include the module: CATAssemblyInterfaces