All Frameworks  Object Hierarchy  This Framework  Indexes

CacheSettingAtt (Object)

Represents the base object to handle the parameters of the cache.

Property Index

ActivationMode
Returns or sets the activation state of cache.
CacheMaxSizeMo
Returns or sets the value of the cache maximum size.
LODMode
Returns or sets the LOD generation mode parameter.
LocalPath
Retrieves or sets the cache local path.
ReleasedVoxel
Returns or sets the released voxel parameter.
SizeControl
Return or sets the cache size control.
TimestampMode
Retrieves or sets the timestamp control.
UTCTimeFormat
Retrieves or sets the the cache timestamp format.

Method Index

GetActivationModeInfo
Retrieves informations about the Cache activation mode.
GetCacheMaxSizeMoInfo
Retrieves environment informations for the Cache maximum size.
GetLODModeInfo
Retrieves environment informations for the LOD generation mode.
GetLocalPathInfo
Retrieves environment informations for the Cache local path.
GetReleasePathInfo
Retrieves environment informations for the Cache release path.
GetReleasePath
Retieves the cache release paths.
GetReleasedVoxelInfo
Retrieves environment informations for the Cache released voxel.
GetSizeControlInfo
Retrieves environment informations for the size control mode.
GetTimestampModeInfo
Retrieves environment informations for the timestamp control mode.
GetUTCTimeFormatInfo
Retrieves environment informations for the timestamp control mode.
PutReleasePath
Sets the cache release paths.
SetActivationModeLock
Locks or unlocks the Cache Activation mode.
SetCacheMaxSizeMoLock
Locks the paramater Cache maximum size.
SetLODModeLock
Locks or unlocks the LOD generation mode.
SetLocalPathLock
Locks or unlocks the cache local path parameter.
SetReleasePathLock
Locks or unlocks the cache local path parameter.
SetReleasedVoxelLock
Locks or unlocks the released voxel parameter.
SetSizeControlLock
Locks or unlocks the cache size control parameter.
SetTimestampModeLock
Locks or unlocks the timestamp control in cache.
SetUTCTimeFormatLock
Locks or unlocks the timestamp format.

Properties


o Property ActivationMode() As
Returns or sets the activation state of cache.
Role: Returns or sets the value of cache activation.
o Property CacheMaxSizeMo() As
Returns or sets the value of the cache maximum size.
Role: Returns or sets the value of the maximum allowed cache size in Mo
o Property LODMode() As
Returns or sets the LOD generation mode parameter.
Role: Returns or sets the value of the LOD generation mode.
o Property LocalPath() As
Retrieves or sets the cache local path.
Role: Retrieves or sets the value of the cache local path. If the local path is defined with environment variables then this method return the unexpansed form.
o Property ReleasedVoxel() As
Returns or sets the released voxel parameter.
Role: Returns or sets the value of the released voxel parameter.
o Property SizeControl() As
Return or sets the cache size control.
Role: Returns or sets the cache size control. The cache use this parameter in conjunction with the maxixum allowed cache size. If it is turned off, the cache size has no limit.
o Property TimestampMode() As
Retrieves or sets the timestamp control.
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.
o Property UTCTimeFormat() As
Retrieves or sets the the cache timestamp format.
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.

Methods


o Func GetActivationModeInfo( AdminLevel,
oLocked) As
Retrieves informations about the Cache activation mode.
Refer to SettingController for a detailled description.
o Func GetCacheMaxSizeMoInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the Cache maximum size.
Refer to SettingController for a detailled description.
o Func GetLODModeInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the LOD generation mode.
Refer to SettingController for a detailled description.
o Func GetLocalPathInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the Cache local path.
Refer to SettingController for a detailled description.
o Func GetReleasePathInfo( AdminLevel,
Locked) As
Retrieves environment informations for the Cache release path.
Refer to SettingController for a detailled description.
o Func GetReleasePath() As
Retieves the cache release paths.
Role: Sets the cache release paths in a symbolic format.
Parameters:
ioRelPath
a CATSafeArrayVariant of CATBSTR.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetReleasedVoxelInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the Cache released voxel.
Refer to SettingController for a detailled description.
o Func GetSizeControlInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the size control mode.
Refer to SettingController for a detailled description.
o Func GetTimestampModeInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the timestamp control mode.
Refer to SettingController for a detailled description.
o Func GetUTCTimeFormatInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the timestamp control mode.
Refer to SettingController for a detailled description.
o Sub PutReleasePath( iRelPath)
Sets the cache release paths.
Role: Sets the cache release paths in a symbolic format.
Parameters:
iRelPath
a CATSafeArrayVariant of CATBSTR.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetActivationModeLock( iLocked)
Locks or unlocks the Cache Activation mode.
Refer to SettingController for a detailled description.
o Sub SetCacheMaxSizeMoLock( iLocked)
Locks the paramater Cache maximum size.
Refer to SettingController for a detailled description.
o Sub SetLODModeLock( iLocked)
Locks or unlocks the LOD generation mode.
Refer to SettingController for a detailled description.
o Sub SetLocalPathLock( iLocked)
Locks or unlocks the cache local path parameter.
Refer to SettingController for a detailled description.
o Sub SetReleasePathLock( iLocked)
Locks or unlocks the cache local path parameter.
Refer to SettingController for a detailled description.
o Sub SetReleasedVoxelLock( iLocked)
Locks or unlocks the released voxel parameter.
Refer to SettingController for a detailled description.
o Sub SetSizeControlLock( iLocked)
Locks or unlocks the cache size control parameter.
Refer to SettingController for a detailled description.
o Sub SetTimestampModeLock( iLocked)
Locks or unlocks the timestamp control in cache.
Refer to SettingController for a detailled description.
o Sub SetUTCTimeFormatLock( iLocked)
Locks or unlocks the timestamp format.
Refer to SettingController for a detailled description.

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