All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATAssemblyInterfaces Interface CATIAsmConstraintSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIAsmConstraintSettingAtt
 

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


interface CATIAsmConstraintSettingAtt

Interface to modify Assembly Design options.
Role: This interface may be used to read or modify the options of Assembly Design..


Method Index


o GetConstraintCreationMode(ConstraintCreationMode&)
Retrieves the constraint creation option.
o GetConstraintCreationModeInfo(CATSettingInfo*)
Retrieves the state of the constraint creation option.
o GetPasteComponentMode(PasteComponentMode&)
Retrieves the paste component option.
o GetPasteComponentModeInfo(CATSettingInfo*)
Retrieves the state of the paste component option.
o GetQuickConstraintMode(QuickConstraintMode&)
Retrieves the quick constraint option.
o GetQuickConstraintModeInfo(CATSettingInfo*)
Retrieves the state of the quick constraint option.
o GetQuickConstraintOrderedList(char**&,int&)
Retrieves the full ordered types list for quick constraint option.
o GetRedundancyMode(RedundantMode&)
Retrieves the redundancy check for constraint creation option.
o SetConstraintCreationMode(ConstraintCreationMode)
Sets the constraint creation option.
o SetConstraintCreationModeLock(unsigned char)
Locks or unlocks the constraint creation option.
o SetPasteComponentMode(PasteComponentMode)
Sets the paste component option.
o SetPasteComponentModeLock(unsigned char)
Locks or unlocks the paste component option.
o SetQuickConstraintMode(QuickConstraintMode)
Sets the quick constraint option.
o SetQuickConstraintModeLock(unsigned char)
Locks or unlocks the quick constraint option.
o SetQuickConstraintOrderedList(char**,int)
Retrieves the full ordered types list for quick constraint option.
o SetRedundancyMode(RedundantMode)
Sets the redundancy check for constraint creation option.

Enumerated Type Index


o ConstraintCreationMode
Constraint creation mode.
o PasteComponentMode
Paste component mode.
o QuickConstraintMode
Quick constraint mode.
o RedundantMode
Redundancy check mode.

Methods


o GetConstraintCreationMode
public virtual HRESULT GetConstraintCreationMode(ConstraintCreationMode& oConstraintCreationMode)= 0
Retrieves the constraint creation option.
Parameters:
oConstraintCreationMode
Legal values:
AnyGeometry : The constraint can be created on any kind of geometry
PublishedGeometryChildLevel : The constraint can only be created on geometry published on the direct child level
PublishedGeometryAnyLevel : The constraint can only be created on geometry published on any assembly level
Returns:
S_OK
on success
E_FAIL
on failure
o GetConstraintCreationModeInfo
public virtual HRESULT GetConstraintCreationModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the constraint creation option.
Parameters:
oInfo
Address of the
CATSettingInfo object.
Returns:
S_OK
on success
E_FAIL
on failure
o GetPasteComponentMode
public virtual HRESULT GetPasteComponentMode(PasteComponentMode& oPasteComponentMode)= 0
Retrieves the paste component option.
Parameters:
oPasteComponentMode
Legal values:
WithoutCsts : The component's constraints will not be recreated
WithCstOnCopy : The component's constraints will only be recreated after a Copy
WithCstOnCut : The component's constraints will only be recreated after a Cut
WithCstOnCopyAndCut : The component's constraints will be recreated after a Copy or a Cut
Returns:
S_OK
on success
E_FAIL
on failure
o GetPasteComponentModeInfo
public virtual HRESULT GetPasteComponentModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the paste component option.
Parameters:
oInfo
Address of the
CATSettingInfo object.
Returns:
S_OK
on success
E_FAIL
on failure
o GetQuickConstraintMode
public virtual HRESULT GetQuickConstraintMode(QuickConstraintMode& oQuickConstraintMode)= 0
Retrieves the quick constraint option.
Parameters:
oQuickConstraintMode
Legal values:
SpecifiedOrder : Use the specified order
catVerifiedConstraintFirst : Create verified constraint first
Returns:
S_OK
on success
E_FAIL
on failure
o GetQuickConstraintModeInfo
public virtual HRESULT GetQuickConstraintModeInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the quick constraint option.
Parameters:
oInfo
Address of the
CATSettingInfo object.
Returns:
S_OK
on success
E_FAIL
on failure
o GetQuickConstraintOrderedList
public virtual HRESULT GetQuickConstraintOrderedList(char**& oList,
int& oSize)= 0
Retrieves the full ordered types list for quick constraint option.
Parameters:
oList
The ordered constraintes types list The constraints types must be precise strings
oSize
The size of the list
Returns:
S_OK
on success
E_FAIL
on failure
o GetRedundancyMode
public virtual HRESULT GetRedundancyMode(RedundantMode& oRedundantMode)= 0
Retrieves the redundancy check for constraint creation option.
Parameters:
oRedundantMode
Legal values:
UnChecked : When redundancy check is ON.
Checked : When redundancy check is OFF.
Returns:
S_OK
on success
E_FAIL
on failure
o SetConstraintCreationMode
public virtual HRESULT SetConstraintCreationMode( const ConstraintCreationMode iConstraintCreationMode)= 0
Sets the constraint creation option.
Parameters:
iConstraintCreationMode
Legal values:
AnyGeometry : The constraint can be created on any kind of geometry
PublishedGeometryChildLevel : The constraint can only be created on geometry published on the direct child level
PublishedGeometryAnyLevel : The constraint can only be created on geometry published on any assembly level
Returns:
S_OK
on success
E_FAIL
on failure
o SetConstraintCreationModeLock
public virtual HRESULT SetConstraintCreationModeLock(unsigned char iLock)= 0
Locks or unlocks the constraint creation 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 SetPasteComponentMode
public virtual HRESULT SetPasteComponentMode( const PasteComponentMode iPasteComponentMode)= 0
Sets the paste component option.
Parameters:
iPasteComponentMode
Legal values:
WithoutCsts : The component's constraints will not be recreated
WithCstOnCopy : The component's constraints will only be recreated after a Copy
WithCstOnCut : The component's constraints will only be recreated after a Cut
WithCstOnCopyAndCut : The component's constraints will be recreated after a Copy or a Cut
Returns:
S_OK
on success
E_FAIL
on failure
o SetPasteComponentModeLock
public virtual HRESULT SetPasteComponentModeLock(unsigned char iLock)= 0
Locks or unlocks the paste component 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 SetQuickConstraintMode
public virtual HRESULT SetQuickConstraintMode( const QuickConstraintMode iQuickConstraintMode)= 0
Sets the quick constraint option.
Parameters:
iQuickConstraintMode
Legal values:
SpecifiedOrder : Use the specified order
catVerifiedConstraintFirst : Create verified constraint first
Returns:
S_OK
on success
E_FAIL
on failure
o SetQuickConstraintModeLock
public virtual HRESULT SetQuickConstraintModeLock(unsigned char iLock)= 0
Locks or unlocks the quick constraint 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 SetQuickConstraintOrderedList
public virtual HRESULT SetQuickConstraintOrderedList( const char** iList,
const int oSize)= 0
Retrieves the full ordered types list for quick constraint option.
Parameters:
iList
The ordered constraintes types list The constraints types must be precise strings
iSize
The size of the list
Returns:
S_OK
on success
E_FAIL
on failure
o SetRedundancyMode
public virtual HRESULT SetRedundancyMode( const RedundantMode iRedundantMode)= 0
Sets the redundancy check for constraint creation option.
Parameters:
oRedundantMode
Legal values:
UnChecked : When redundancy check is ON.
Checked : When redundancy check is OFF.
Returns:
S_OK
on success
E_FAIL
on failure

Enumerated Types


o ConstraintCreationMode
enum ConstraintCreationMode {
  AnyGeometry,
  PublishedGeometryChildLevel,
  PublishedGeometryAnyLevel
}
Constraint creation mode. The mode is used as input parameter in
SetConstraintCreationMode and as output parameter in GetConstraintCreationMode
Parameters:
AnyGeometry
The constraint can be created on any kind of geometry.
PublishGeometryChildLevel
The constraint can only be created on geometry published on the direct child level.
PublishGeometryAnyLevel
The constraint can only be created on geometry published on any assembly level.
o PasteComponentMode
enum PasteComponentMode {
  WithoutCsts,
  WithCstOnCopy,
  WithCstOnCut,
  WithCstOnCopyAndCut
}
Paste component mode. The mode is used as input parameter in
SetPasteComponentMode and as output parameter in GetPasteComponentMode
Parameters:
WithoutCsts
The component's constraints will not be recreated.
WithCstOnCopy
The component's constraints will only be recreated after a Copy.
WithCstOnCut
The component's constraints will only be recreated after a Cut.
WithCstOnCopyAndCut
The component's constraints will be recreated after a Copy or a Cut.
o QuickConstraintMode
enum QuickConstraintMode {
  SpecifiedOrder,
  VerifiedConstraintFirst
}
Quick constraint mode.
Parameters:
catSpecifiedOrder
Use the specified order.
catVerifiedConstraintFirst
Create verified constraint first.
o RedundantMode
enum RedundantMode {
  UnChecked,
  Checked
}
Redundancy check mode.
Parameters:
catUnChecked
Redundancy of constraint is checked while constraint creation.
catChecked
Redundancy of constraint is not checked while constraint creation.

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

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