All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Class CATSettingInfo

CATSettingInfo
 

Usage: you must use this class as is. You should never derive it.


public class CATSettingInfo

Defines the information corresponding to an attribute.

Role: Defines the informations that can be used by Tools Options' dialog objects.


Constructor and Destructor Index


o CATSettingInfo()
Constructs an instance.
o CATSettingInfo(CATSettingInfo&)
Copy constructor.
o ~CATSettingInfo()

Method Index


o GetLock(char&)
Retrieves the lock state of the attribute encapsulated in the CATSettingInfo.
o GetOrigineValue(CATString*&)
Retrieves the origine of the encapsulated attribute's value.
o Lock()
Locks the encapsulated attribute into the encapsulated CATSettingRepository, in order to prevent any further modifications of its value.
o Unlock()
Unlocks the encapsulated attribute into the encapsulated CATSettingRepository, in order to allow further modifications of its value.
o operator =(CATSettingInfo&)
Equal operator.
o operator ==(CATSettingInfo&)
Equality operator.

Constructor and Destructor


o CATSettingInfo
public CATSettingInfo()
Constructs an instance. In order to give the different values embedded in this class, you need to use the CATSettingRepository.GetInfo method.
o CATSettingInfo
public CATSettingInfo( const CATSettingInfo& iOriginal)
Copy constructor.
o ~CATSettingInfo
public virtual ~CATSettingInfo()

Methods


o GetLock
public HRESULT GetLock(char& oLock)
Retrieves the lock state of the attribute encapsulated in the CATSettingInfo.
Parameters:
oLock
the state of the lock.
Returns:
S_OK if the CATSettingInfo is correctly implemented, and the lock attribute is correctly set. E_FAIL otherwise.
o GetOrigineValue
public HRESULT GetOrigineValue(CATString*& oOrigineValue)
Retrieves the origine of the encapsulated attribute's value.

If the encapsulated attribute has been locked, this is the level of administration where the lock is located,
If the attribute is not locked, this is the level that would impose its value to the encapsulated attribute in case of a reset.
Parameters:
oOrigineValue
the path of the level of administration
Returns:
S_OK on success E_FAIL if something went wrong
o Lock
public HRESULT Lock()
Locks the encapsulated attribute into the encapsulated CATSettingRepository, in order to prevent any further modifications of its value. This methods is only applicable in Administrator's mode. Otherwise it does nothing.
Returns:
S_OK if the attribute was successfully locked E_FAIL otherwise.
o Unlock
public HRESULT Unlock()
Unlocks the encapsulated attribute into the encapsulated CATSettingRepository, in order to allow further modifications of its value. This methods is only applicable in Administrator's mode. Otherwise it does nothing.
Returns:
S_OK if the attribute was successfully unlocked E_FAIL otherwise.
o operator =
public CATSettingInfo& operator =( const CATSettingInfo& )
Equal operator.
o operator ==
public int operator ==( const CATSettingInfo& iInfo) const
Equality operator.
Parameters:
iInfo
The SettingInfo to compare to the current one
Returns:
boolean
Legal values: 0: False the condition is not fullfilled, or Other: True if the condition is fullfilled.

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

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