All Frameworks  Class Hierarchy  This Framework  Indexes   

CATOBMInterfaces Interface CATIBKTBehaviorSettingAtt

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


interface CATIBKTBehaviorSettingAtt

Enables attribute access to BKT options.


Method Index


o GetBKTAccessRightsInfo(CATSettingInfo*)
Retrieves the state of the BKTAccessRights parameter.
o GetBKTAccessRights(unsigned int&)
Retrieves the BKTAccessRights attribute.
o GetBKTBehaviorOperationMessageInfo(CATSettingInfo*)
Retrieves the state of the BKTBehaviorOperationMessage parameter.
o GetBKTBehaviorOperationMessage(unsigned int&)
Retrieves or sets the BKTBehaviorOperationMessage parameter.
o GetBKTSpecificationTreeInfo(CATSettingInfo*)
Retrieves the state of the BKTSpecificationTree parameter.
o GetBKTSpecificationTree(unsigned int&)
Retrieves the BKTSpecificationTree parameter.
o SetBKTAccessRightsLock(unsigned char)
Locks or unlocks the BKTAccessRights parameter.
o SetBKTAccessRights(unsigned int)
Sets the BKTAccessRights attribute.
o SetBKTBehaviorOperationMessageLock(unsigned char)
Locks or unlocks the BKTBehaviorOperationMessage parameter.
o SetBKTBehaviorOperationMessage(unsigned int)
Sets the BKTBehaviorOperationMessage parameter.
o SetBKTSpecificationTreeLock(unsigned char)
Locks or unlocks the BKTSpecificationTree parameter.
o SetBKTSpecificationTree(unsigned int)
Sets the BKTSpecificationTree parameter.

Methods


o GetBKTAccessRightsInfo
public virtual GetBKTAccessRightsInfo( oInfo)
Retrieves the state of the BKTAccessRights parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTAccessRights
public virtual GetBKTAccessRights( ioBKTAccessRights)
Retrieves the BKTAccessRights attribute.
Parameters:
ioBKTAccessRights
Legal values:
0 : User mode
1: Administrator mode
2: Expert mode
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTBehaviorOperationMessageInfo
public virtual GetBKTBehaviorOperationMessageInfo( oInfo)
Retrieves the state of the BKTBehaviorOperationMessage parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTBehaviorOperationMessage
public virtual GetBKTBehaviorOperationMessage( ioBKTBehaviorOperationMessage)
Retrieves or sets the BKTBehaviorOperationMessage parameter.
Parameters:
ioBKTBehaviorOperationMessage
Legal values:
0 : No operation messages
1: with operation messages
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTSpecificationTreeInfo
public virtual GetBKTSpecificationTreeInfo( oInfo)
Retrieves the state of the BKTSpecificationTree parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBKTSpecificationTree
public virtual GetBKTSpecificationTree( ioBKTSpecificationTree)
Retrieves the BKTSpecificationTree parameter.
Parameters:
ioBKTSpecificationTree
Legal values:
0 : hides behaviors variables
1: displays behaviors variables
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTAccessRightsLock
public virtual SetBKTAccessRightsLock( iLocked)
Locks or unlocks the BKTAccessRights parameter.
Role: Locks or unlocks the BKTAccessRights 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 SetBKTAccessRights
public virtual SetBKTAccessRights( iBKTAccessRights)
Sets the BKTAccessRights attribute.
Parameters:
iBKTAccessRights
Legal values:
0 : User mode
1: Administrator mode
2: Expert mode
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTBehaviorOperationMessageLock
public virtual SetBKTBehaviorOperationMessageLock( iLocked)
Locks or unlocks the BKTBehaviorOperationMessage parameter.
Role: Locks or unlocks the BKTBehaviorOperationMessage 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 SetBKTBehaviorOperationMessage
public virtual SetBKTBehaviorOperationMessage( iBKTBehaviorOperationMessage)
Sets the BKTBehaviorOperationMessage parameter.
Parameters:
iBKTBehaviorOperationMessage
Legal values:
0 : No operation messages
1: with operation messages
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBKTSpecificationTreeLock
public virtual SetBKTSpecificationTreeLock( iLocked)
Locks or unlocks the BKTSpecificationTree parameter.
Role: Locks or unlocks the BKTSpecificationTree 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 SetBKTSpecificationTree
public virtual SetBKTSpecificationTree( iBKTSpecificationTree)
Sets the BKTSpecificationTree parameter.
Parameters:
iBKTSpecificationTree
Legal values:
0 : hides behaviors variables
1: displays behaviors variables
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

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

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