All Frameworks  Class Hierarchy  This Framework  Indexes   

KnowledgeInterfaces Interface CATILieKnowledgeSheetSettingAtt

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


interface CATILieKnowledgeSheetSettingAtt

The interface to access a CATIAKnowledgeSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values of Knowledge sheet.


Method Index


o GetDesignTablesCopyDataInfo(CATSettingInfo*)
Retrieves the state of the DesignTablesCopyData parameter.
o GetDesignTablesCopyData(int&)
Retrieves the DesignTablesCopyData attribute.
o GetDesignTablesSynchronizationInfo(CATSettingInfo*)
Retrieves the state of the DesignTablesSynchronization parameter.
o GetDesignTablesSynchronization(int&)
Retrieves the DesignTablesSynchronization attribute.
o GetParameterNameSurroundedByTheSymbolInfo(CATSettingInfo*)
Retrieves the state of the ParameterNameSurroundedByTheSymbol parameter.
o GetParameterNameSurroundedByTheSymbol(int&)
Retrieves the ParameterNameSurroundedByTheSymbol attribute.
o GetParameterTreeViewWithFormulaInfo(CATSettingInfo*)
Retrieves the state of the ParameterTreeViewWithFormula parameter.
o GetParameterTreeViewWithFormula(int&)
Retrieves the ParameterTreeViewWithFormula attribute.
o GetParameterTreeViewWithValueInfo(CATSettingInfo*)
Retrieves the state of the ParameterTreeViewWithValue parameter.
o GetParameterTreeViewWithValue(int&)
Retrieves the ParameterTreeViewWithValue attribute.
o GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo(CATSettingInfo*)
Retrieves the state of the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
o GetRelationsUpdateInPartContextEvaluateDuringUpdate(int&)
Retrieves the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
o GetRelationsUpdateInPartContextSynchronousRelationsInfo(CATSettingInfo*)
Retrieves the state of the RelationsUpdateInPartContextSynchronousRelations parameter.
o GetRelationsUpdateInPartContextSynchronousRelations(int&)
Retrieves the RelationsUpdateInPartContextSynchronousRelations attribute.
o SetDesignTablesCopyDataLock(unsigned char)
Locks or unlocks the DesignTablesCopyData parameter.
o SetDesignTablesCopyData(int&)
Sets the DesignTablesCopyData attribute.
o SetDesignTablesSynchronizationLock(unsigned char)
Locks or unlocks the DesignTablesSynchronization parameter.
o SetDesignTablesSynchronization(int&)
Sets the DesignTablesSynchronization attribute.
o SetParameterNameSurroundedByTheSymbolLock(unsigned char)
Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter.
o SetParameterNameSurroundedByTheSymbol(int&)
Sets the ParameterNameSurroundedByTheSymbol attribute.
o SetParameterTreeViewWithFormulaLock(unsigned char)
Locks or unlocks the ParameterTreeViewWithFormula parameter.
o SetParameterTreeViewWithFormula(int&)
Sets the ParameterTreeViewWithFormula attribute.
o SetParameterTreeViewWithValueLock(unsigned char)
Locks or unlocks the ParameterTreeViewWithValue parameter.
o SetParameterTreeViewWithValue(int&)
Sets the ParameterTreeViewWithValue attribute.
o SetRelationsUpdateInPartContextEvaluateDuringUpdateLock(unsigned char)
Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
o SetRelationsUpdateInPartContextEvaluateDuringUpdate(int&)
Sets the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
o SetRelationsUpdateInPartContextSynchronousRelationsLock(unsigned char)
Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations parameter.
o SetRelationsUpdateInPartContextSynchronousRelations(int&)
Sets the RelationsUpdateInPartContextSynchronousRelations attribute.

Methods


o GetDesignTablesCopyDataInfo
public virtual GetDesignTablesCopyDataInfo( oInfo)
Retrieves the state of the DesignTablesCopyData parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesCopyData
public virtual GetDesignTablesCopyData( ioDesignTablesCopyData)
Retrieves the DesignTablesCopyData attribute.
Parameters:
ioDesignTablesCopyData
Legal values:
0 : default mode for design table : copy data into models
1 : default mode for design table : do not copy data into models.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesSynchronizationInfo
public virtual GetDesignTablesSynchronizationInfo( oInfo)
Retrieves the state of the DesignTablesSynchronization parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetDesignTablesSynchronization
public virtual GetDesignTablesSynchronization( ioDesignTablesSynchronization)
Retrieves the DesignTablesSynchronization attribute.
Parameters:
ioDesignTablesSynchronization
Legal values:
0 : automatic synchronization at load for design table
1 : interactive synchronization at load for design table
2 : manual synchronization for design table.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterNameSurroundedByTheSymbolInfo
public virtual GetParameterNameSurroundedByTheSymbolInfo( oInfo)
Retrieves the state of the ParameterNameSurroundedByTheSymbol parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterNameSurroundedByTheSymbol
public virtual GetParameterNameSurroundedByTheSymbol( ioParameterNameSurroundedByTheSymbol)
Retrieves the ParameterNameSurroundedByTheSymbol attribute.
Parameters:
ioParameterNameSurroundedByTheSymbol
Legal values:
0 : to see parameter name not surrounded by the symbol "'"
1 : to see parameter name surrounded by the symbol "'".
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithFormulaInfo
public virtual GetParameterTreeViewWithFormulaInfo( oInfo)
Retrieves the state of the ParameterTreeViewWithFormula parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithFormula
public virtual GetParameterTreeViewWithFormula( ioParameterTreeViewWithFormula)
Retrieves the ParameterTreeViewWithFormula attribute.
Parameters:
ioParameterTreeViewWithFormula
Legal values:
0 : to see parameter tree view without formula
1 : to see parameter tree view with formula.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithValueInfo
public virtual GetParameterTreeViewWithValueInfo( oInfo)
Retrieves the state of the ParameterTreeViewWithValue parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetParameterTreeViewWithValue
public virtual GetParameterTreeViewWithValue( ioParameterTreeViewWithValue)
Retrieves the ParameterTreeViewWithValue attribute.
Parameters:
oParameterTreeViewWithValue
Legal values:
0 : to see parameter tree view without value
1 : to see parameter tree view with value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo
public virtual GetRelationsUpdateInPartContextEvaluateDuringUpdateInfo( oInfo)
Retrieves the state of the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextEvaluateDuringUpdate
public virtual GetRelationsUpdateInPartContextEvaluateDuringUpdate( ioRelationsUpdateInPartContextEvaluateDuringUpdate)
Retrieves the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
Parameters:
ioRelationsUpdateInPartContextEvaluateDuringUpdate
Legal values:
0 : creation of relations not evaluate during update
1 : creation of relations evaluate during update.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextSynchronousRelationsInfo
public virtual GetRelationsUpdateInPartContextSynchronousRelationsInfo( oInfo)
Retrieves the state of the RelationsUpdateInPartContextSynchronousRelations parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o GetRelationsUpdateInPartContextSynchronousRelations
public virtual GetRelationsUpdateInPartContextSynchronousRelations( ioRelationsUpdateInPartContextSynchronousRelations)
Retrieves the RelationsUpdateInPartContextSynchronousRelations attribute.
Parameters:
ioRelationsUpdateInPartContextSynchronousRelations
Legal values:
0 : creation of unsynchronous relations
1 : creation of synchronous relations.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesCopyDataLock
public virtual SetDesignTablesCopyDataLock( iLocked)
Locks or unlocks the DesignTablesCopyData parameter.
Role: Locks or unlocks the DesignTablesCopyData parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesCopyData
public virtual SetDesignTablesCopyData( const iDesignTablesCopyData)
Sets the DesignTablesCopyData attribute.
Parameters:
iDesignTablesCopyData
Legal values:
0 : default mode for design table : copy data into models
1 : default mode for design table : do not copy data into models.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesSynchronizationLock
public virtual SetDesignTablesSynchronizationLock( iLocked)
Locks or unlocks the DesignTablesSynchronization parameter.
Role: Locks or unlocks the DesignTablesSynchronization parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetDesignTablesSynchronization
public virtual SetDesignTablesSynchronization( const iDesignTablesSynchronization)
Sets the DesignTablesSynchronization attribute.
Parameters:
iDesignTablesSynchronization
Legal values:
0 : automatic synchronization at load for design table
1 : interactive synchronization at load for design table
2 : manual synchronization for design table.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterNameSurroundedByTheSymbolLock
public virtual SetParameterNameSurroundedByTheSymbolLock( iLocked)
Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter.
Role: Locks or unlocks the ParameterNameSurroundedByTheSymbol parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterNameSurroundedByTheSymbol
public virtual SetParameterNameSurroundedByTheSymbol( const iParameterNameSurroundedByTheSymbol)
Sets the ParameterNameSurroundedByTheSymbol attribute.
Parameters:
iParameterNameSurroundedByTheSymbol
Legal values:
0 : to see parameter name not surrounded by the symbol "'"
1 : to see parameter name surrounded by the symbol "'".
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithFormulaLock
public virtual SetParameterTreeViewWithFormulaLock( iLocked)
Locks or unlocks the ParameterTreeViewWithFormula parameter.
Role: Locks or unlocks the ParameterTreeViewWithFormula parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithFormula
public virtual SetParameterTreeViewWithFormula( const iParameterTreeViewWithFormula)
Sets the ParameterTreeViewWithFormula attribute.
Parameters:
iParameterTreeViewWithFormula
Legal values:
0 : to see parameter tree view without formula
1 : to see parameter tree view with formula.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithValueLock
public virtual SetParameterTreeViewWithValueLock( iLocked)
Locks or unlocks the ParameterTreeViewWithValue parameter.
Role: Locks or unlocks the ParameterTreeViewWithValue parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetParameterTreeViewWithValue
public virtual SetParameterTreeViewWithValue( const iParameterTreeViewWithValue)
Sets the ParameterTreeViewWithValue attribute.
Parameters:
iParameterTreeViewWithValue
Legal values:
0 : to see parameter tree view without value
1 : to see parameter tree view with value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextEvaluateDuringUpdateLock
public virtual SetRelationsUpdateInPartContextEvaluateDuringUpdateLock( iLocked)
Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate parameter.
Role: Locks or unlocks the RelationsUpdateInPartContextEvaluateDuringUpdate parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextEvaluateDuringUpdate
public virtual SetRelationsUpdateInPartContextEvaluateDuringUpdate( const iRelationsUpdateInPartContextEvaluateDuringUpdate)
Sets the RelationsUpdateInPartContextEvaluateDuringUpdate attribute.
Parameters:
ioRelationsUpdateInPartContextEvaluateDuringUpdate
Legal values:
0 : creation of relations not evaluate during update
1 : creation of relations evaluate during update.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextSynchronousRelationsLock
public virtual SetRelationsUpdateInPartContextSynchronousRelationsLock( iLocked)
Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations parameter.
Role: Locks or unlocks the RelationsUpdateInPartContextSynchronousRelations parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.
o SetRelationsUpdateInPartContextSynchronousRelations
public virtual SetRelationsUpdateInPartContextSynchronousRelations( const iRelationsUpdateInPartContextSynchronousRelations)
Sets the RelationsUpdateInPartContextSynchronousRelations attribute.
Parameters:
iRelationsUpdateInPartContextSynchronousRelations
Legal values:
0 : creation of unsynchronous relations
1 : creation of synchronous relations.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure.

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

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