All Frameworks  Object Hierarchy  This Framework  Indexes

HtsCCPSettingAtt (Object)


Property Index

AutomatizedCCP
Returns or sets the AutoCCP parameter.
CompassPos
Returns or sets the CompassPos parameter.
CurrentPos
Returns or sets the CurrentPos parameter.
FirstAct
Returns or sets the FirstAct parameter.
LastAct
Returns or sets the LastAct parameter.

Method Index

GetAutoCCPInfo
Retrieves environment informations for the AutoCCP parameter.
GetCompassPosInfo
Retrieves environment informations for the CompassPos parameter.
GetCurrentPosInfo
Retrieves environment informations for the CurrentPos parameter.
GetFirstActInfo
Retrieves environment informations for the FirstAct parameter.
GetLastActInfo
Retrieves environment informations for the LastAct parameter.
SetAutoCCPLock
Locks or unlocks the AutoCCP parameter.
SetCompassPosLock
Locks or unlocks the CompassPos parameter.
SetCurrentPosLock
Locks or unlocks the CurrentPos parameter.
SetFirstActLock
Locks or unlocks the FirstAct parameter.
SetLastActLock
Locks or unlocks the LastAct parameter.

Properties


o Property AutomatizedCCP() As
Returns or sets the AutoCCP parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CompassPos() As
Returns or sets the CompassPos parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CurrentPos() As
Returns or sets the CurrentPos parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property FirstAct() As
Returns or sets the FirstAct parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property LastAct() As
Returns or sets the LastAct parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Methods


o Func GetAutoCCPInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AutoCCP parameter.
Role:Retrieves the state of the AutoCCP parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCompassPosInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CompassPos parameter.
Role:Retrieves the state of the CompassPos parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCurrentPosInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CurrentPos parameter.
Role:Retrieves the state of the CurrentPos parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetFirstActInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the FirstAct parameter.
Role:Retrieves the state of the FirstAct parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetLastActInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the LastAct parameter.
Role:Retrieves the state of the LastAct parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub SetAutoCCPLock( iLocked)
Locks or unlocks the AutoCCP parameter.
Role:Locks or unlocks the AutoCCP parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCompassPosLock( iLocked)
Locks or unlocks the CompassPos parameter.
Role:Locks or unlocks the CompassPos parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCurrentPosLock( iLocked)
Locks or unlocks the CurrentPos parameter.
Role:Locks or unlocks the CurrentPos parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetFirstActLock( iLocked)
Locks or unlocks the FirstAct parameter.
Role:Locks or unlocks the FirstAct parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetLastActLock( iLocked)
Locks or unlocks the LastAct parameter.
Role:Locks or unlocks the LastAct parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

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