All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Interface CATISysCacheSettingAtt

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

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


interface CATISysCacheSettingAtt

Interface to handle the parameters of the cache.
Role: This interface is implemented by a component which represents the controller of the cache.
This interface defines:


Method Index


o GetActivationMode(unsigned char&)
Retrieves the cache's activation state.
o GetActivationModeInfo(CATSettingInfo*)
Retrieves the state of the parameter cache activation.
o GetCacheMaxSizeMo(unsigned int&)
Retrieves the value of the cache maximum size.
o GetCacheMaxSizeMoInfo(CATSettingInfo*)
Retrieves informations about the parameter cache maximum size.
o GetLODMode(unsigned char&)
Retrieves the value of the LOD generation mode.
o GetLODModeInfo(CATSettingInfo*)
Retrieves the state of the LOD generation mode.
o GetLocalPath(CATUnicodeString**)
Retrieves the cache local path.
o GetLocalPathInfo(CATSettingInfo*)
Retrieves the state of the parameter cache local Path.
o GetLocalPathSymb(CATUnicodeString**)
Retrieves the cache local path.
o GetReleasePath(unsigned int&,CATUnicodeString**&)
Retrieves the cache release paths.
o GetReleasePathInfo(CATSettingInfo*)
Retrieves the state of the parameter cache release paths.
o GetReleasePathSymb(unsigned int&,CATUnicodeString**&)
Retrieves the cache release paths.
o GetReleasedVoxel(float&)
Retrieves the value of the released voxel parameter.
o GetReleasedVoxelInfo(CATSettingInfo*)
Retrieves the state of the parameter released voxel.
o GetSizeControl(unsigned char&)
Retrieves if the cache size control is activated.
o GetSizeControlInfo(CATSettingInfo*)
Retrieves the state of the parameter cache size control.
o GetTimestampMode(unsigned char&)
Retrieves if the timestamp control is activated.
o GetTimestampModeInfo(CATSettingInfo*)
Retrieves the state of the parameter timestamp control.
o GetUTCTimeFormat(unsigned char&)
Retrieves if the timestamp is expressed in UTC or local time.
o GetUTCTimeFormatInfo(CATSettingInfo*)
Retrieves the state of the parameter timestamp format.
o SetActivationMode(unsigned char)
Turns ON/OFF the cache activation.
o SetActivationModeLock(unsigned char)
Locks or unlocks the cache activation mode.
o SetCacheMaxSizeMo(unsigned int)
Sets the value of the cache maximum size.
o SetCacheMaxSizeMoLock(unsigned char)
Locks or unlocks the paramater Cache maximum size.
o SetLODMode(unsigned char)
Sets the value of the LOD generation mode.
o SetLODModeLock(unsigned char)
Locks or unlocks the LOD generation mode.
o SetLocalPath(CATUnicodeString&,int*)
Sets the cache local path.
o SetLocalPathLock(unsigned char)
Locks or unlocks the cache local path.
o SetReleasePath(unsigned int,CATUnicodeString**)
Sets the cache release paths.
o SetReleasePathLock(unsigned char)
Locks or unlocks the cache release paths.
o SetReleasedVoxel(float)
Sets the value of the released voxel parameter.
o SetReleasedVoxelLock(unsigned char)
Locks or unlocks the paramater released voxel.
o SetSizeControl(unsigned char)
Turns ON/OFF the cache size control mechanism.
o SetSizeControlLock(unsigned char)
Locks or unlocks the cache size control mode.
o SetTimestampMode(unsigned char)
Turns ON/OFF the cache timestamp control mechanism.
o SetTimestampModeLock(unsigned char)
Locks or unlocks the timestamp control mode.
o SetUTCTimeFormat(unsigned char)
Sets the the cache timestamp format in UTC.
o SetUTCTimeFormatLock(unsigned char)
Locks or unlocks the timestamp format.

Methods


o GetActivationMode
public virtual HRESULT GetActivationMode(unsigned char& oMode)=0
Retrieves the cache's activation state.
Parameters:
oMode
Legal values:
0: turned off
1: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetActivationModeInfo
public virtual HRESULT GetActivationModeInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter cache activation.
Refer to CATSysSettingController for a detailled description.
o GetCacheMaxSizeMo
public virtual HRESULT GetCacheMaxSizeMo(unsigned int& oSize)=0
Retrieves the value of the cache maximum size.
Role: Retrieves the value of the cache maximum size in Mo
Parameters:
oSize
The maximum allowed size of the cache in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCacheMaxSizeMoInfo
public virtual HRESULT GetCacheMaxSizeMoInfo(CATSettingInfo* oInfo)=0
Retrieves informations about the parameter cache maximum size.
Refer to CATSysSettingController for a detailled description.
o GetLODMode
public virtual HRESULT GetLODMode(unsigned char& oMode)=0
Retrieves the value of the LOD generation mode.
Parameters:
oMode
the LOD generation mode for the cache content.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLODModeInfo
public virtual HRESULT GetLODModeInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the LOD generation mode.
Refer to CATSysSettingController for a detailled description.
o GetLocalPath
public virtual HRESULT GetLocalPath(CATUnicodeString** oLocalPath)=0
Retrieves the cache local path.
Role: Retrieves the value of the cache local path. If the local path is defined with environment variables then this method return the expansed form. The unexpansed form can be retrieved with GetLocalPathSymb.
Parameters:
oLocalPath
the local path of the cache.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLocalPathInfo
public virtual HRESULT GetLocalPathInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter cache local Path.
Refer to CATSysSettingController for a detailled description.
o GetLocalPathSymb
public virtual HRESULT GetLocalPathSymb(CATUnicodeString** oLocalPath)=0
Retrieves the cache local path.
Role: Retrieves the cache local path in a symbolic format. If the local path is defined with environment variables then this method return the literal form for example ${CATCache}.
Parameters:
oLocalPath
the local path of the cache.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReleasePath
public virtual HRESULT GetReleasePath(unsigned int& oNbDir,
CATUnicodeString**& oLocalPath)=0
Retrieves the cache release paths.
Role: Retrieves the cache release paths. If the release paths has been defined with environment variables then this method return the expansed form.
Parameters:
oNbDir
the number of directories in the release path.
oRelPath
the method allocates an array of pointer of CATUnicodeString of oNbDir elements that must be desallocated by the caller.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReleasePathInfo
public virtual HRESULT GetReleasePathInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter cache release paths.
Refer to CATSysSettingController for a detailled description.
o GetReleasePathSymb
public virtual HRESULT GetReleasePathSymb(unsigned int& oNbDir,
CATUnicodeString**& oRelPath)=0
Retrieves the cache release paths.
Role: Retrieves the cache release paths in a symbolic format. If the release paths has been defined with environment variables then this method return the literal form for example ${CATCache}.
Parameters:
oNbDir
the number of directories in the release path.
oRelPath
the method allocates an array of pointer of CATUnicodeString of oNbDir elements that must be desallocated by the caller.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReleasedVoxel
public virtual HRESULT GetReleasedVoxel(float& oVoxel)=0
Retrieves the value of the released voxel parameter.
Parameters:
oVoxel
the released voxel.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetReleasedVoxelInfo
public virtual HRESULT GetReleasedVoxelInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter released voxel.
Refer to CATSysSettingController for a detailled description.
o GetSizeControl
public virtual HRESULT GetSizeControl(unsigned char& oMode)=0
Retrieves if the cache size control is activated.
Parameters:
oMode
Legal values:
0: turned off
1: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSizeControlInfo
public virtual HRESULT GetSizeControlInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter cache size control.
Refer to CATSysSettingController for a detailled description.
o GetTimestampMode
public virtual HRESULT GetTimestampMode(unsigned char& oMode)=0
Retrieves if the timestamp control is activated.
Role: If the timestamp control is turned on, the cache will verify if the cached object is uptodate with the master object. If not a new cached view will be generated.
If the timestamp control is turned off, the cache will consider that the cached views are always uptodate with their master object.
Parameters:
oMode
Legal values:
0: turned off
1: turned on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTimestampModeInfo
public virtual HRESULT GetTimestampModeInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter timestamp control.
Refer to CATSysSettingController for a detailled description.
o GetUTCTimeFormat
public virtual HRESULT GetUTCTimeFormat(unsigned char& oMode)=0
Retrieves if the timestamp is expressed in UTC or local time.
Role: If the timestamp format is set to TRUE, then the time used used as timestamp by the cache is expressed in UTC format (GMT), in the other case the local time is used. The default format is local time.
Parameters:
oMode
Legal values:
0: timestamps are in local time
1: timestamps are in UTC.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUTCTimeFormatInfo
public virtual HRESULT GetUTCTimeFormatInfo(CATSettingInfo* oInfo)=0
Retrieves the state of the parameter timestamp format.
Refer to CATSysSettingController for a detailled description.
o SetActivationMode
public virtual HRESULT SetActivationMode(unsigned char iMode)=0
Turns ON/OFF the cache activation.
Role: Activates or desactivates the cache mechanism.
Parameters:
iMode
Legal values:
0: to turn off
1: to turn on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetActivationModeLock
public virtual HRESULT SetActivationModeLock(unsigned char iLock)=0
Locks or unlocks the cache activation mode.
Refer to CATSysSettingController for a detailled description.
o SetCacheMaxSizeMo
public virtual HRESULT SetCacheMaxSizeMo(unsigned int iSize)=0
Sets the value of the cache maximum size.
Role: Sets the value of the cache maximum size in Mo
Parameters:
oSize
The maximum allowed size of the cache in Mo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCacheMaxSizeMoLock
public virtual HRESULT SetCacheMaxSizeMoLock(unsigned char iLock)=0
Locks or unlocks the paramater Cache maximum size.
Refer to CATSysSettingController for a detailled description.
o SetLODMode
public virtual HRESULT SetLODMode(unsigned char iMode)=0
Sets the value of the LOD generation mode.
Parameters:
oMode
the LOD generation mode for the cache content.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLODModeLock
public virtual HRESULT SetLODModeLock(unsigned char iLock)=0
Locks or unlocks the LOD generation mode.
Refer to CATSysSettingController for a detailled description.
o SetLocalPath
public virtual HRESULT SetLocalPath(CATUnicodeString& iLocalPath,
int* oNew=0)=0
Sets the cache local path.
Role: Sets the cache local path in a symbolic format.
Parameters:
iLocalPath
the local path of the cache.
oNew
not to be used. Reserved for internal use.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLocalPathLock
public virtual HRESULT SetLocalPathLock(unsigned char iLock)=0
Locks or unlocks the cache local path.
Refer to CATSysSettingController for a detailled description.
o SetReleasePath
public virtual HRESULT SetReleasePath(unsigned int iNbDir,
CATUnicodeString** iRelPath)=0
Sets the cache release paths.
Role: Sets the cache release paths in a symbolic format.
Parameters:
iNbDir
the number of directories in the release path.
iRelPath
an array of pointer of CATUnicodeString of iNbDir elements.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReleasePathLock
public virtual HRESULT SetReleasePathLock(unsigned char iLock)=0
Locks or unlocks the cache release paths.
Refer to CATSysSettingController for a detailled description.
o SetReleasedVoxel
public virtual HRESULT SetReleasedVoxel(float iVoxel)=0
Sets the value of the released voxel parameter.
Parameters:
iVoxel
the released voxel.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetReleasedVoxelLock
public virtual HRESULT SetReleasedVoxelLock(unsigned char iLock)=0
Locks or unlocks the paramater released voxel.
Refer to CATSysSettingController for a detailled description.
o SetSizeControl
public virtual HRESULT SetSizeControl(unsigned char iMode)=0
Turns ON/OFF the cache size control mechanism.
Role: Activates or desactivates the cache size control mechanism. It is used in conjunction with the maxixum allowed cache size. If it is turned off, the cache size has no limit.
Parameters:
iMode
Legal values:
0: to turn off
1: to turn on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSizeControlLock
public virtual HRESULT SetSizeControlLock(unsigned char iLock)=0
Locks or unlocks the cache size control mode.
Refer to CATSysSettingController for a detailled description.
o SetTimestampMode
public virtual HRESULT SetTimestampMode(unsigned char iMode)=0
Turns ON/OFF the cache timestamp control mechanism.
Role: If the timestamp control is turned on, the cache will verify if the cached object is uptodate with the master object. If not a new cached view will be generated.
If the timestamp control is turned off, the cache will consider that the cached views are always uptodate with their master object.
Parameters:
iMode
Legal values:
0: to turn off
1: to turn on
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTimestampModeLock
public virtual HRESULT SetTimestampModeLock(unsigned char iLock)=0
Locks or unlocks the timestamp control mode.
Refer to CATSysSettingController for a detailled description.
o SetUTCTimeFormat
public virtual HRESULT SetUTCTimeFormat(unsigned char iMode)=0
Sets the the cache timestamp format in UTC.
Role: If the timestamp format is set to TRUE, then the time used used as timestamp by the cache is expressed in UTC format (GMT), in the other case the local time is used. The default format is local time.
Parameters:
iMode
Legal values:
0: to activate the Local time format.
1: to activate the UTC format.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUTCTimeFormatLock
public virtual HRESULT SetUTCTimeFormatLock(unsigned char iLock)=0
Locks or unlocks the timestamp format.
Refer to CATSysSettingController for a detailled description.

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

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